Spot by NetApp API (1.0)

query Parameters

generateToken

any

Example: generateToken=true

If true, then the response will include personalAccessToken string

Request Body schema: application/json

email	string Email
firstName	string The first name of the user
lastName	string The last name of the user
password	string Password
role	string User's role

Responses

Request samples

Payload

Content type

application/json

{"firstName": "Test",
"lastName": "Test",
"email": "test@spot.io",
"password": "password1234",
"role": "viewer"
}

Response samples

Content type

application/json

{"request": {"id": "46642c7d-bc29-417d-8ce4-79626f00c63c",
"url": "/setup/user/?generateToken=true",
"method": "POST",
"timestamp": "2018-11-19T13:49:11.911Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:setup:user",
"items": [{"id": 9056,
"firstName": "Test",
"lastName": "Test",
"displayName": "Test Test",
"email": "test@gmail.com",
"organizationId": 606079860000,
"personalAccessToken": "...",
"userId": "u-1a2b3c4d"
}
],
"count": 1
}
}

Get Users

Get all the users of the organization.

Authorizations:

Responses

Response samples

Content type

application/json

{"request": {"id": "3ab3fdf7-3af3-46db-9e63-b88cfdac058c",
"url": "/setup/organization/user",
"method": "GET",
"timestamp": "2018-08-20T15:31:12.730Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"userId": "u-a1b2c3d4",
"username": "John Doe",
"type": "personal",
"email": "john.doe@company.com",
"mfa": "false",
"groupNames": ["Developers",
"DevOps"
]
},
{"userId": "u-4d3c2b1a",
"userName": "Jane Doe",
"type": "personal",
"email": "jane.doe@company.com",
"mfa": "true",
"groupNames": ["DevOps",
"IT"
]
}
],
"count": 2,
"kind": "spotinst:setup:organization:user"
}
}

Get Policies

Get all the policies of the organization.

Authorizations:

Responses

Response samples

Content type

application/json

{"request": {"id": "3ab3fdf7-3af3-46db-9e63-b88cfdac058c",
"url": "/setup/organization/policy",
"method": "GET",
"timestamp": "2018-08-20T15:31:12.730Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "pol-a1b2c3d4",
"name": "Developers",
"description": "A policy that contains permissions for developers",
"type": "ORGANIZATION",
"policyContent": {"statements": [{"effect": "ALLOW",
"actions": ["elastigroup:createGroup",
"elastigroup:updateGroup"
],
"resources": ["*"
]
}
]
},
"createdAt": "2021-12-19T13:44:13.000+0000",
"updatedAt": "2022-01-02T22:04:29.000+0000"
},
{"id": "pol-87654321",
"name": "DevOps",
"description": "A policy that contains permissions for DevOps",
"type": "ACCOUNT",
"policyContent": {"statements": [{"effect": "ALLOW",
"actions": ["setup:updatePolicy"
],
"resources": ["*"
]
}
]
},
"createdAt": "2021-12-19T13:44:13.000+0000",
"updatedAt": "2022-01-02T22:04:29.000+0000"
}
],
"count": 2,
"kind": "spotinst:setup:organization:policy"
}
}

Get User Details

Get all the details of a given user.

Authorizations:

path Parameters

userId

required

string

Example: u-1234abcd

Identifier of a user.

Responses

Response samples

Content type

application/json

{"request": {"id": "3ab3fdf7-3af3-46db-9e63-b88cfdac058c",
"url": "/setup/user/u-1234abcd",
"method": "GET",
"timestamp": "2018-08-20T15:31:12.730Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": {"userId": "u-a1b2c3d4",
"username": "John Doe",
"type": "personal",
"email": "john.doe@company.com",
"mfa": "false",
"groups": [{"id": "ugr-12345678",
"name": "DevOps",
"policyNames": ["DevOps-PROD",
"DevOps-DEV",
"IT"
]
},
{"id": "ugr-87654321",
"name": "IT",
"policyNames": ["IT"
]
}
],
"policies": [{"policyId": "pol-12345678",
"policyName": "TriggerDeployment",
"policyType": "ACCOUNT",
"accountIds": ["act-12345678",
"act-87654321"
]
},
{"policyId": "pol-87654321",
"policyName": "UpdateScheduling",
"policyType": "ORGANIZATION",
"accountIds": [ ]
}
],
"tokens": [{"name": "my_sweet_token",
"createdAt": "2020-06-01T12:17:51.000+000",
"tokenId": 11111,
"tokenLastDigits": "2323"
}
]
},
"count": 1,
"kind": "spotinst:setup:access:user"
}
}

Delete user

Delete a given user(console or programmatic) from organization.

Authorizations:

path Parameters

userId

required

string

Example: u-1234abcd or pu-87654321

Identifier of a user.

Responses

Response samples

Content type

application/json

{"request": {"id": "3ab3fdf7-3af3-46db-9e63-b88cfdac058c",
"url": "/setup/user/u-1234abcd",
"method": "DELETE",
"timestamp": "2018-08-20T15:31:12.730Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

User - Update User Group Mapping

Update the mapping of a given user to user groups

Authorizations:

path Parameters

userId

required

string

Example: u-1234abcd

Identifier of a user.

Request Body schema: application/json

userGroupIds

array

A list of the user groups to register the given user to (should be existing user groups only)

Responses

Request samples

Payload

Content type

application/json

{"userGroupIds": ["ugr-12345678",
"ugr-87654321"
]
}

Response samples

Content type

application/json

{"request": {"id": "3ab3fdf7-3af3-46db-9e63-b88cfdac058c",
"url": "/setup/user/u-1234abcd/userGroupMapping",
"method": "PUT",
"timestamp": "2018-08-20T15:31:12.730Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

User - Update Policy Mapping

Update the mapping of a given user directly to policies

Authorizations:

path Parameters

userId

required

string

Example: u-1234abcd

Identifier of a user.

Request Body schema: application/json

Array of objects[ items ]

The policies to register under the given user (should be existing policies only)

Array

accountIds	Array of strings A list of account IDs to register with the assigned under the given user (should be existing accounts only)
policyId	string A policy ID to register under the given user (should be existing policy only)

Responses

Request samples

Payload

Content type

application/json

{"policies": [{"policyId": "pol-12345678",
"accountIds": ["act-12345678"
]
},
{"policyId": "pol-87654321",
"accountIds": ["act-12345678",
"act-87654321"
]
}
]
}

Response samples

Content type

application/json

{"request": {"id": "3ab3fdf7-3af3-46db-9e63-b88cfdac058c",
"url": "/setup/user/u-1234abcd/policyMapping?accountId=act-567c21",
"method": "PUT",
"timestamp": "2018-08-20T15:31:12.730Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Get User

Get user's account mapping

Authorizations:

query Parameters

userEmail

required

any

Example: userEmail=test@spot.io

Target user email address

Responses

Response samples

Content type

application/json

{"request": {"id": "46642c7d-bc29-417d-8ce4-79626f00c63c",
"url": "/accountUserMapping?userEmail=test@spot.io",
"method": "GET",
"timestamp": "2018-11-19T13:49:11.911Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:aws:ec2:group:log",
"items": [{"accountId": "act-1234592",
"role": "editor"
},
{"accountId": "act-1234593",
"role": "viewer"
}
],
"count": 2
}
}

Delete Organization

Delete a Spot Organization. ID of the organization can be obtained from your Spot console via the following link: https://console.spotinst.com/#/settings/organization/general > Note: This cannot be undone. Take caution.

Authorizations:

path Parameters

organizationId

required

any

Example: 606079812345

ID of the organization you would like to delete

Responses

Response samples

Content type

application/json

{"request": {"id": "46642c7d-bc29-417d-8ce4-79626f00c63c",
"url": "/setup/organization/606079812345",
"method": "DELETE",
"timestamp": "2018-11-19T13:49:11.911Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Create Programmatic User

This API creates a new programmatic user (not a human user). Use this API to provide privileges to an application that needs to interface with Spot. Spot returns a token that the programmatic user can use to perform actions with. requires accounts or policies.

Authorizations:

Request Body schema: application/json

	Array of objects[ items ] All the accounts the programmatic user will have access to. If used - Cannot be empty.
description	string Brief description of the user.
name required	string Name of the programmatic user.
	Array of objects[ items ] All the policies the programmatic user will have access to. If used - Cannot be empty.

Responses

Request samples

Payload

Content type

application/json

{"description": "test programmatic",
"name": "testProgrammaticApi",
"accounts": [{"id": "act-123",
"role": "viewer"
}
],
"policies": [{"policyId": "pol-123",
"accountIds": ["act-123",
"act-321"
]
}
]
}

Response samples

Content type

application/json

{"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:setup:programmaticUser",
"items": [{"token": "f872e7b157866a36229d915aa21cf430f661234568703fd",
"name": "TestApi1",
"id": "pu-6a6976ab"
}
],
"count": 1
}
}

Create Organization

Create a Spot Organization.

Authorizations:

Request Body schema: application/json

object

Organization

name	string Provide a name for your organization. The organization name must contain at least one character that is a-z or A-Z

Responses

Request samples

Payload

Content type

application/json

{"organization": {"name": "organizationName"
}
}

Response samples

Content type

application/json

{"request": {"id": "46642c7d-bc29-417d-8ce4-79626f00c63c",
"url": "/setup/organization",
"method": "POST",
"timestamp": "2018-11-19T13:49:11.911Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:setup:organization",
"items": [{"organizationId": 12345678,
"organizationName": "organizationName"
}
],
"count": 1
}
}

Get Access Policy Actions

Get actions for access policies.

Authorizations:

query Parameters

category	string Example: category=update The policy action category that you would like to get the information for
name	string Example: name=ocean:updateCluster The policy action Name that you would like to get the information for
resourcePattern	string Example: resourcePattern=ocean:o-* The policy action resource pattern that you would like to get the information for
scope	string Example: scope=account The policy action scope that you would like to get the information for
service	string Example: service=ocean The policy action service that you would like to get the information for

Responses

Response samples

Content type

application/json

{"request": {"id": "3ab3fdf7-3af3-46db-9e63-b88cfdac058c",
"url": "/setup/access/policyAction?service=ocean&resourcePattern=ocean:ols-*&category=update",
"method": "GET",
"timestamp": "2022-04-14T05:05:26.044Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"name": "ocean:updateLaunchSpec",
"service": "ocean",
"resourcePattern": "ocean:ols-*",
"scope": "ACCOUNT",
"category": "UPDATE"
},
{"name": "ocean:launchNodesInLaunchSpec",
"service": "ocean",
"resourcePattern": "ocean:ols-*",
"scope": "ACCOUNT",
"category": "UPDATE"
},
{"name": "ocean:updateClusterLaunchSpec",
"service": "ocean",
"resourcePattern": "ocean:ols-*",
"scope": "ACCOUNT",
"category": "UPDATE"
}
],
"count": 3,
"kind": "spotinst:setup:policyAction"
}
}

Create Access Policy

Create an access policy. access policy enables you to define the user's permissions on a granular level than the role-based permissions.

Authorizations:

Request Body schema: application/json

object

Set access policy settings. Example - Acme, Inc.

description	string Short description of policy
name	string Name of the Policy
	object Set permissions objects list

Responses

Request samples

Payload

Content type

application/json

{"policy": {"name": "my policy",
"description": "description of my policy",
"policyContent": {"statements": [{"effect": "ALLOW",
"actions": [["ocean:importCluster"
]
],
"resources": [["*"
]
]
},
{"effect": "ALLOW",
"actions": [["emr:scale"
]
],
"resources": [["*"
]
]
}
]
}
}
}

Response samples

Content type

application/json

{"request": {"id": "46642c7d-bc29-417d-8ce4-79626f00c63c",
"url": "/setup/access/policy?accountId=act-6sd665cs\"",
"method": "POST",
"timestamp": "2018-11-19T13:49:11.911Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:setup:access:policy",
"items": [{"name": "my policy",
"description": "description of my policy",
"policyContent": [ ],
"id": "pol-de9716be"
}
],
"count": 1
}
}

Update Access Policy

Updates an access policy settings.

Authorizations:

path Parameters

policyId

required

any

Example: pol-2344nn

The access policy ID to update

Request Body schema: application/json

object

Set access policy settings

name	string Set access policy name

Responses

Request samples

Payload

Content type

application/json

{"policy": {"name": "A wonderful policy"
}
}

Response samples

Content type

application/json

{"request": {"id": "46642c7d-bc29-417d-8ce4-79626f00c63c",
"url": "/setup/access/policy/pol-2344nn?accountId=act-4fbdvfc6",
"method": "PUT",
"timestamp": "2018-11-19T13:49:11.911Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Delete Access Policy

Deletes an access policy settings.

Authorizations:

path Parameters

policyId

required

any

Example: pol-2344nn

The access policy ID to delete

Responses

Response samples

Content type

application/json

{"request": {"id": "46642c7d-bc29-417d-8ce4-79626f00c63c",
"url": "/setup/access/policy/pol-2344nn?accountId=act-123456789",
"method": "DELETE",
"timestamp": "2018-11-19T13:49:11.911Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

List All User Groups

List all user-groups of your Spot organization

Authorizations:

Responses

Response samples

Content type

application/json

{"request": {"id": "3ab3fdf7-3af3-46db-9e63-b88cfdac058c",
"url": "/setup/access/userGroup?accountId=act-567c21",
"method": "GET",
"timestamp": "2018-08-20T15:31:12.730Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "ugr-a1b2c3d4",
"name": "Developers",
"description": "managing permissions to my group of developers",
"createdAt": "2020-11-04T11:29:10.000+0000",
"usersCount": 10,
"policyNames": ["TriggerDeployment"
]
},
{"id": "ugr-4d3c2b1a",
"name": "DevOps",
"description": "managing permissions to my group of DevOps",
"createdAt": "2020-09-01T11:28:00.000+0000",
"usersCount": 5,
"policyNames": ["TriggerDeployment",
"UpdateScaling",
"UpdateScheduling"
]
}
],
"count": 2,
"kind": "spotinst:setup:access:userGroup"
}
}

Create a new User Group

Create a new user-group of your Spot organization

Authorizations:

Request Body schema: application/json

description	string user group description
name	string user group name
	Array of objects[ items ] The policies to register under the given group (should be existing policies only)
userIds	Array of strings The users to register under the created group (should be existing users only)

Responses

Request samples

Payload

Content type

application/json

{"name": "Developers",
"description": "managing permissions to my group of developers",
"userIds": ["u-12345678",
"pu-12345678"
],
"policies": [{"policyId": "pol-12345678",
"accountIds": ["act-12345678"
]
},
{"policyId": "pol-87654321",
"accountIds": ["act-12345678",
"act-87654321"
]
}
]
}

Response samples

Content type

application/json

{"request": {"id": "3ab3fdf7-3af3-46db-9e63-b88cfdac058c",
"url": "/setup/access/userGroup?accountId=act-567c21",
"method": "POST",
"timestamp": "2018-08-20T15:31:12.730Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": {"id": "ugr-a1b2c3d4",
"name": "Developers",
"description": "managing permissions to my group of developers",
"createdAt": "2020-11-04T11:29:10.000+0000",
"userIds": ["u-12345678",
"pu-12345678"
],
"policies": [{"policyId": "pol-12345678",
"accountIds": ["act-12345678"
]
},
{"policyId": "pol-87654321",
"accountIds": ["act-12345678",
"act-87654321"
]
}
]
},
"count": 1,
"kind": "spotinst:setup:access:userGroup"
}
}

Get User Group Details

Get the details of a user Group

Authorizations:

path Parameters

userGroupId

required

string

Example: ugr-1234abcd

Identifier of a user Group.

Responses

Response samples

Content type

application/json

{"request": {"id": "3ab3fdf7-3af3-46db-9e63-b88cfdac058c",
"url": "/setup/access/userGroup/urg-1234abcd?accountId=act-567c21",
"method": "GET",
"timestamp": "2018-08-20T15:31:12.730Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": {"id": "ugr-a1b2c3d4",
"name": "Developers",
"description": "managing permissions to my group of developers",
"createdAt": "2020-11-04T11:29:10.000+0000",
"users": [{"userId": "u-12345678",
"userName": "Clark Kent",
"type": "personal"
},
{"userId": "pu-87654321",
"userName": "Superman",
"type": "programmatic"
}
],
"policies": [{"policyId": "pol-12345678",
"policyName": "TriggerDeployment",
"policyType": "ACCOUNT",
"accountIds": ["act-12345678",
"act-87654321"
]
},
{"policyId": "pol-87654321",
"policyName": "UpdateScheduling",
"policyType": "ORGANIZATION"
}
]
},
"count": 1,
"kind": "spotinst:setup:access:userGroup"
}
}

Update User Group Details

Update the details of a user Group

Authorizations:

path Parameters

userGroupId

required

string

Example: ugr-1234abcd

Identifier of a user Group.

Request Body schema: application/json

description	string non-empty user group description
name	string non-empty user group name

Responses

Request samples

Payload

Content type

application/json

{"name": "Developers",
"description": "managing permissions to my group of developers"
}

Response samples

Content type

application/json

{"request": {"id": "3ab3fdf7-3af3-46db-9e63-b88cfdac058c",
"url": "/setup/access/userGroup/urg-1234abcd?accountId=act-567c21",
"method": "PUT",
"timestamp": "2018-08-20T15:31:12.730Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Delete User Group

Delete a user Group

Authorizations:

path Parameters

userGroupId

required

string

Example: ugr-1234abcd

Identifier of a user Group.

Responses

Response samples

Content type

application/json

{"request": {"id": "3ab3fdf7-3af3-46db-9e63-b88cfdac058c",
"url": "/setup/access/userGroup/urg-1234abcd?accountId=act-567c21",
"method": "DELETE",
"timestamp": "2018-08-20T15:31:12.730Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

User Group - Update User Mapping

Update the mapping of a given user group to users

Authorizations:

path Parameters

userGroupId

required

string

Example: ugr-1234abcd

Identifier of a user Group.

Request Body schema: application/json

userIds

array

The users to register under the given user group (should be existing users only)

Responses

Request samples

Payload

Content type

application/json

{"userIds": ["u-12345678",
"pu-12345678"
]
}

Response samples

Content type

application/json

{"request": {"id": "3ab3fdf7-3af3-46db-9e63-b88cfdac058c",
"url": "/setup/access/userGroup/urg-1234abcd/userMapping?accountId=act-567c21",
"method": "PUT",
"timestamp": "2018-08-20T15:31:12.730Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

User Group - Update Policy Mapping

Update the mapping of a given user group to policies

Authorizations:

path Parameters

userGroupId

required

string

Example: ugr-1234abcd

Identifier of a user Group.

Request Body schema: application/json

Array of objects[ items ]

The policies to register under the given user group (should be existing policies only)

Array

accountIds	Array of strings A list of accounts to register with the assigned under the given group (should be existing accounts only)
policyId	string A policy to register under the given group (should be existing policy only)

Responses

Request samples

Payload

Content type

application/json

{"policies": [{"policyId": "pol-12345678",
"accountIds": ["act-12345678"
]
},
{"policyId": "pol-87654321",
"accountIds": ["act-12345678",
"act-87654321"
]
}
]
}

Response samples

Content type

application/json

{"request": {"id": "3ab3fdf7-3af3-46db-9e63-b88cfdac058c",
"url": "/setup/access/userGroup/urg-1234abcd/policyMapping?accountId=act-567c21",
"method": "PUT",
"timestamp": "2018-08-20T15:31:12.730Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Accounts

Update Account

Update information in an account such as the account name and slack channel. To use this command, permissions for organization admin are required. Granular permissions will require access policies with the following actions: setup:updateAccount

Authorizations:

path Parameters

accountId

required

string

Example: act-123abc

ID of the account you would like to update

Request Body schema: application/json

required

object

Used for updating items in an account.

name	string The new name of the account. Cannot be null or empty.
slackNotificationChannels	Array of strings List of strings containing the URLs of the slack channels to be added.

Responses

Request samples

Payload

Content type

application/json

{"account": {"slackNotificationChannels": [["https://hooks.slack.com/services/SLACK_ID",
"https://hooks.slack.com/services/SLACK_ID"
]
],
"name": "ACCOUNT_NAME"
}
}

Response samples

Content type

application/json

{"request": {"id": "46642c7d-bc29-417d-8ce4-79626f00c63c",
"url": "/setup/account/act-4fb595c6?accountId=act-4fb595c6",
"method": "PUT",
"timestamp": "2018-11-19T13:49:11.911Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Delete Account

Delete a Spot Account. The Spot Account ID can be obtained from your Spot console via the following link: https://console.spotinst.com/#/settings/account/general . Note This cannot be undone – take caution. Only Organization Admins can perform this action. In case you want to delete your default Spot account which is the account visible when you first log in please contact Support.

Authorizations:

path Parameters

accountId

required

any

Example: act-123456

ID of the account you would like to delete

Responses

Response samples

Content type

application/json

{"request": {"id": "46642c7d-bc29-417d-8ce4-79626f00c63c",
"url": "/setup/account/act-123456",
"method": "DELETE",
"timestamp": "2018-11-19T13:49:11.911Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Get Users

Get all users in the organization, their details, and mapped accounts. Providing the optional account ID parameter will filter out all users not mapped to that account.

Authorizations:

query Parameters

accountId

any

Example: accountId=act-123abc

ID of the account you would like to get retrieve users from

Responses

Response samples

Content type

application/json

{"request": {"id": "46642c7d-bc29-417d-8ce4-79626f00c63c",
"url": "/setup/user?accountId=act-123456789",
"method": "GET",
"timestamp": "2018-11-19T13:49:11.911Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:aws:ec2:group:log",
"items": [{"mappedAccountIds": ["act-0b18f123",
"act-0b18f124",
"act-0b18f125"
],
"userId": "u-19265",
"displayName": "test",
"email": "test@spot.io"
},
{"mappedAccountIds": ["act-0b18f123",
"act-0b18f124",
"act-0b18f125"
],
"userId": "u-19266",
"displayName": "test",
"email": "abc@google.com"
}
],
"count": 2
}
}

Assign Users to Accounts

Assign users to accounts in bulk. Only accounts under the creator's own organization are allowed. Creator's organization ID is taken from the personal token attached to the API call.

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

One of

mappings

Array of any[ items ]

Mappings objects include user, accountID and role.

Responses

Request samples

Payload

Content type

application/json

Example

{"mappings": [{"userId": "u-1234",
"accountId": "act-123abc",
"role": "editor"
},
{"userId": "u-1234",
"accountId": "act-123abc",
"permissionStrategy": "ROLE_BASED",
"role": "editor"
}
]
}

Response samples

Content type

application/json

{"request": {"id": "46642c7d-bc29-417d-8ce4-79626f00c63c",
"url": "/setup/accountUserMapping?accountId=act-4fab9sc6",
"method": "POST",
"timestamp": "2018-11-19T13:49:11.911Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Update User Permissions

Change the users' permissions for an account (only accounts under the creator's own organization are allowed). Creator's organization ID is taken from the personal token attached to the API call.

Authorizations:

path Parameters

accountId

string

Example: act-123abc

ID of the account associated with your token

Request Body schema: application/json

One of

permissionStrategy	string Default: "ROLE_BASED" Set the user permissions type, by role or by access policy. Valid values "ROLE_BASED", "POLICY_BASED"
role	string Valid values "viewer", "editor". Required on permissionStrategy = ROLE_BASED
userId	string One of userEmail / userId is required. identify user by its user ID

Responses

Request samples

Payload

Content type

application/json

Example

{"userId": "u-1234",
"permissionStrategy": "POLICY_BASED",
"role": "editor"
}

Response samples

Content type

application/json

{"request": {"id": "46642c7d-bc29-417d-8ce4-79626f00c63c",
"url": "/setup/account/act-4fb595c6/user/",
"method": "PUT",
"timestamp": "2018-11-19T13:49:11.911Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Detach User

Detach a user from an account (only accounts under the creator's own organization are allowed). Creator's organization ID is taken from the personal token attached to the API call.

Authorizations:

path Parameters

accountId

required

any

Example: act-123abc

Account ID

Request Body schema: application/json

userEmail

required

string

Email of the user that is going to be deleted

Responses

Request samples

Payload

Content type

application/json

{"userEmail": "test@gmail.com"
}

Response samples

Content type

application/json

{"request": {"id": "46642c7d-bc29-417d-8ce4-79626f00c63c",
"url": "/setup/account/act-12345678/user/",
"method": "DELETE",
"timestamp": "2018-11-19T13:49:11.911Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Set Existing User Permissions

Add a user to the account and set its permissions on the account. Creator's organization ID is taken from the personal token attached to the API call.

Authorizations:

path Parameters

accountId

required

any

Example: act-123abc

Account ID

Request Body schema: application/json

One of

role	string Valid values - "viewer", "editor". Required on permissionStrategy = ROLE_BASED
userEmail	string One of userEmail / userId is required. identify user by its user ID

Responses

Request samples

Payload

Content type

application/json

Example

{"userEmail": "test@spot.io",
"role": "viewer"
}

Response samples

Content type

application/json

{"request": {"id": "46642c7d-bc29-417d-8ce4-79626f00c63c",
"url": "/setup/account/act-4fb765c6/user",
"method": "PUT",
"timestamp": "2018-11-19T13:49:11.911Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Create Account

Create a Spot account.

Authorizations:

Request Body schema: application/json

object

Account

name	string Provide a name for your account. The account name must contain at least one character that is a-z or A-Z

Responses

Request samples

Payload

Content type

application/json

{"account": {"name": "AccountName"
}
}

Response samples

Content type

application/json

{"request": {"id": "46642c7d-bc29-417d-8ce4-79626f00c63c",
"url": "/setup/account",
"method": "POST",
"timestamp": "2018-11-19T13:49:11.911Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:setup:account",
"items": [{"id": "act-123456",
"name": "AccountName",
"organizationId": 606012341234
}
],
"count": 1
}
}

List Accounts

Get a list of Spot accounts in your organization. When used without any parameters, the provided token must have Organization Admin permissions and the output will contain all the Organization's accounts. Note In case you want to list all the accounts associated with Organization you can use the below request URL without the cloudAccountId parameter, https://api.spotinst.io/setup/account

Authorizations:

query Parameters

cloudAccountId

string

Example: cloudAccountId=634245686616

Will list only the Spot accounts connected to the specified account ID.

Responses

Response samples

Content type

application/json

{"request": {"id": "46642c7d-bc29-417d-8ce4-79626f00c63c",
"url": "/setup/account?cloudAccountId=123456789",
"method": "GET",
"timestamp": "2018-11-19T13:49:11.911Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:setup:account",
"items": [{"accountId": "act-57765123",
"organizationId": 606079861123,
"name": "test",
"providerExternalId": 123456789
},
{"accountId": "act-57765123",
"organizationId": 606079861123,
"name": "prod",
"providerExternalId": 123456789
}
],
"count": 2
}
}

List Access Policies

Get access policy settings.

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "46642c7d-bc29-417d-8ce4-79626f00c63c",
"url": "/setup/access/policy?accountId=act-4fd325c3",
"method": "GET",
"timestamp": "2018-11-19T13:49:11.911Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:setup:access:policy",
"items": [{"name": "my policy",
"description": "description of my policy",
"policyContent": {"statements": [{"effect": "ALLOW",
"actions": [["ocean:importCluster"
]
],
"resources": [["*"
]
]
},
{"effect": "ALLOW",
"actions": [["emr:scale"
]
],
"resources": [["*"
]
]
}
]
},
"id": "pol-de9716be",
"createdAt": "2020-01-21T12:37:14.000+0000",
"updatedAt": "2020-01-21T12:37:14.000+0000"
}
],
"count": 1
}
}

Get Users Permissions

Get the permissions for all the users in the account.

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "46642c7d-bc29-417d-8ce4-79626f00c63c",
"url": "/setup/user/permission",
"method": "GET",
"timestamp": "2018-11-19T13:49:11.911Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:setup:user:permission",
"items": [{"userId": "u-1235",
"permissionStrategy": "ROLE_BASED",
"role": "editor",
"policyIds": ["string"
]
},
{"userId": "u-12387",
"permissionStrategy": "POLICY_BASED",
"role": "viewer",
"policyIds": ["string"
]
},
{"userId": "u-1234",
"permissionStrategy": "POLICY_BASED",
"role": "viewer",
"policyIds": ["string"
]
}
],
"count": 3
}
}

Set Credentials for AWS

Link a Spot account to an AWS Cloud account.
Please create external id using spot api (see /setup/credentials/aws/externalId)
and use it when creating the AWS role and then call this route with your AWS role's arn to link it to your spot account

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

object

Credentials details

iamRole

string

Provide the IAM Role ARN connected to another AWS account 922761411349 and with the latest Spot Policy - https://docs.spot.io/administration/api/spot-policy-in-aws

Responses

Request samples

Payload

Content type

application/json

{"credentials": {"iamRole": "arn:aws:iam::1234567890:role/Spot_Iam_Role"
}
}

Response samples

Content type

application/json

{"request": {"id": "46642c7d-bc29-417d-8ce4-79626f00c63c",
"url": "/setup/credentials/aws?accountId=act-123456",
"method": "POST",
"timestamp": "2018-11-19T13:49:11.911Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Create AWS account external id

Create aws account external id
You should use the external id when creating your AWS role for your spot account
and after you create the role you need to call set-aws-credentials Set Credentials for AWS
to link your AWS account with your spot account

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "46642c7d-bc29-417d-8ce4-79626f00c63c",
"url": "/setup/credentials/aws/externalId?accountId=act-123456",
"method": "POST",
"timestamp": "2018-11-19T13:49:11.911Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:setup:aws:externalId",
"items": [{"externalId": "SpotinstAwsAccountExternalId",
"maxValidUntil": "2021-03-18T16:11:04.402Z"
}
],
"count": 1
}
}

Set Credentials for GCP

Link a Spot account to a GCP Cloud account.

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

object

Set service account for credentials

auth_provider_x509_cert_url	string Default - https://www.googleapis.com/oauth2/v1/certs
auth_uri	string Authentication uri, Default - https://accounts.google.com/o/oauth2/auth
client_email	string Email associated with service account
client_id	string Client ID of service account
client_x509_cert_url	string Should be in following format - "https://www.googleapis.com/robot/v1/metadata/x509/"
private_key	string Private key of JSON key created during prerequisites stage
private_key_id	string Private key ID of JSON key created during prerequisites stage
project_id	string Name of project in GCP
token_uri	string Token uri, Default - https://oauth2.googleapis.com/token
type	string Valid values - service_account

Responses

Request samples

Payload

Content type

application/json

{"serviceAccount": {"type": "service_account",
"project_id": "test-labs",
"private_key_id": "XXXXXXXXXXXXXXXXX",
"private_key": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"client_email": "test123@spot.io",
"client_id": "XXXXXXXXXXXXXXXXXXXXX",
"auth_uri": "https://accounts.google.com/o/oauth2/auth",
"token_uri": "https://oauth2.googleapis.com/token",
"auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
"client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/test123%40test-labs.iam.gserviceaccount.com"
}
}

Response samples

Content type

application/json

{"request": {"id": "46642c7d-bc29-417d-8ce4-79626f00c63c",
"url": "/gcp/setup/credentials?accountId=act-123456",
"method": "POST",
"timestamp": "2018-11-19T13:49:11.911Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Validate Credentials for GCP

Validate the credentials for connecting a Spot account to an GCP Cloud account. The validation will test the credentials without actually set it. Please notice to run the set credentials request to perform the set account credentials.

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

object

Set service account for credentials

auth_provider_x509_cert_url	string Default - https://www.googleapis.com/oauth2/v1/certs
auth_uri	string Authentication uri, Default - https://accounts.google.com/o/oauth2/auth
client_email	string Email associated with service account
client_id	string Client ID of service account
client_x509_cert_url	string Should be in following format - "https://www.googleapis.com/robot/v1/metadata/x509/"
private_key	string Private key of JSON key created during prerequisites stage
private_key_id	string Private key ID of JSON key created during prerequisites stage
project_id	string Name of project in GCP
token_uri	string Token uri, Default - https://oauth2.googleapis.com/token
type	string Valid values - service_account

Responses

Request samples

Payload

Content type

application/json

{"serviceAccount": {"type": "service_account",
"project_id": "test-labs",
"private_key_id": "XXXXXXXXXXXXXXXXX",
"private_key": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"client_email": "test123@spot.io",
"client_id": "XXXXXXXXXXXXXXXXXXXXX",
"auth_uri": "https://accounts.google.com/o/oauth2/auth",
"token_uri": "https://oauth2.googleapis.com/token",
"auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
"client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/test123%40test-labs.iam.gserviceaccount.com"
}
}

Response samples

Content type

application/json

{"request": {"id": "46642c7d-bc29-417d-8ce4-79626f00c63c",
"url": "/gcp/setup/credentials/validate?accountId=act-123456",
"method": "POST",
"timestamp": "2018-11-19T13:49:11.911Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Set Credentials for Azure

Link a Spot account to an Azure Cloud account.

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

clientId	string Set the application ID
clientSecret	string Set the key secret
subscriptionId	string Set the subscription ID
tenantId	string Set the directory ID

Responses

Request samples

Payload

Content type

application/json

{"clientId": 111111111,
"clientSecret": "32431r2431434132",
"tenantId": "1321e1e3123er23",
"subscriptionId": "234r3141131"
}

Response samples

Content type

application/json

{"request": {"id": "46642c7d-bc29-417d-8ce4-79626f00c63c",
"url": "/azure/setup/credentials?accountId=act-123456",
"method": "POST",
"timestamp": "2018-11-19T13:49:11.911Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Validate Credentials for Azure

Validate the credentials for connecting a Spot account to an Azure Cloud account. The validation will test the credentials without actually set it. Please notice to run the set credentials request to perform the set Azure account credentials (https://docs.spot.io/connect-your-cloud-provider/azure-account) .

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

clientId	string Set the application ID
clientSecret	string Set the key secret
subscriptionId	string Set the subscription ID
tenantId	string Set the directory ID

Responses

Request samples

Payload

Content type

application/json

{"clientId": "111111111",
"clientSecret": "32431r2431434132",
"tenantId": "1321e1e3123er23",
"subscriptionId": "234r3141131"
}

Response samples

Content type

application/json

{"request": {"id": "46642c7d-bc29-417d-8ce4-79626f00c63c",
"url": "/azure/setup/credentials/validation?accountId=act-123456",
"method": "POST",
"timestamp": "2018-11-19T13:49:11.911Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Ocean AWS

Ocean - Serverless containers for Amazon Web Services (AWS)

Create Cluster

Prerequisites

The Ocean Controller is used to monitor the cluster resources and report back to Ocean. The Ocean Controller is required for Ocean Cloud and On-Prem.

To install the Ocean Controller, complete and run the following script on a machine with the kubectl command line tool installed and configured:

#!/usr/bin/env bash
curl -fsSL http://spotinst-public.s3.amazonaws.com/integrations/kubernetes/cluster-controller/scripts/init.sh | \
SPOTINST_TOKEN=<ENTER YOUR TOKEN HERE> \
SPOTINST_ACCOUNT=<ENTER YOUR SPOTINST ACCOUNT ID HERE> \
SPOTINST_CLUSTER_IDENTIFIER=<ENTER YOUR CLUSTER IDENTIFIER HERE> \
bash

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

required

object

The object specifying the configuration of the Ocean cluster.

	object (auto-scaler) The automatic scaling mechanism used in Ocean for Kubernetes.
	object (Capacity Units) The overall capability of the Ocean cluster expressed as number of instances and specified with a minimum, a maximum, and a target number of running instances.
	object (Ocean Compute) Compute specifications for the Ocean cluster.
controllerClusterId required	string Enter the reporting identifier for the Ocean Controller.
	object (Logging configuration)
name required	string Add a name for the Ocean cluster.
region required	string Select the region for the Ocean cluster to run in.
	object (Elastigroup Scheduling) An object used to define times for a task such as a shutdown to be activated.
	object (Security) Object for cluster security features.
	object (Ocean Cluster Strategy) An object defining the cluster strategy with regard to waiting periods and utilization of on-demand and reserved instances.

Responses

Request samples

Payload

Content type

application/json

{"cluster": {"name": "oceanName",
"controllerClusterId": "ocean.k8s",
"region": "us-east-1",
"autoScaler": {"isEnabled": true,
"cooldown": 180,
"resourceLimits": {"maxMemoryGib": 1500,
"maxVCpu": 750
},
"down": {"maxScaleDownPercentage": 60
},
"headroom": {"cpuPerUnit": 2000,
"memoryPerUnit": 0,
"gpuPerUnit": 0,
"numOfUnits": 4
},
"isAutoConfig": false,
"autoHeadroomPercentage": null,
"enableAutomaticAndManualHeadroom": true,
"extendedResourceDefinitions": ["erd-123",
"erd-456"
]
},
"capacity": {"minimum": 0,
"maximum": 1000,
"target": 1
},
"strategy": {"utilizeReservedInstances": true,
"fallbackToOd": true,
"spotPercentage": 100,
"gracePeriod": 600,
"drainingTimeout": 60,
"utilizeCommitments": false
},
"scheduling": {"tasks": [{"isEnabled": true,
"cronExpression": "0 1 * * *",
"taskType": "clusterRoll",
"parameters": {"clusterRoll": {"batchSizePercentage": 20,
"comment": "This is why I deployed my cluster.",
"batchMinHealthyPercentage": 100
}
}
}
],
"shutdownHours": {"timeWindows": ["Sat:08:00-Sun:08:00"
],
"isEnabled": true
}
},
"security": {"containerImage": {"approvedImages": [["*.ecr.*.amazonaws.com/*",
"docker.*"
]
]
}
},
"compute": {"subnetIds": ["subnet-4c1d1538",
"subnet-2791bb61"
],
"instanceTypes": {"whitelist": ["c4.xlarge",
"c4.2xlarge",
"c4.4xlarge",
"c4.8xlarge"
],
"blacklist": ["r5.large",
"r5.xlarge"
]
},
"launchSpecification": {"useAsTemplateOnly": false,
"imageId": "string",
"userData": "string",
"securityGroupIds": [["sg-c3d914b0"
]
],
"iamInstanceProfile": {"arn": "orform"
},
"keyPair": "spotinst-labs-oregon",
"tags": [{"tagKey": "Creator",
"tagValue": "John Doe"
}
],
"loadBalancers": [{"type": "TARGET_GROUP",
"name": "MyTargetGroup",
"arn": "arn:aws:elasticloadbalancing:us-west-2:922761411234:targetgroup"
}
],
"associatePublicIpAddress": false,
"associateIpv6Address": false,
"monitoring": true,
"ebsOptimized": true,
"rootVolumeSize": 73,
"instanceMetadataOptions": {"httpTokens": "optional",
"httpPutResponseHopLimit": 12,
"httpEndpoint": "disabled"
}
}
},
"logging": {"export": {"s3": {"id": "di-123"
}
}
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/aws/k8s/cluster",
"method": "POST",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "o-abcd1234",
"name": "oceanName",
"controllerClusterId": "ocean.k8s",
"region": "us-east-1",
"autoScaler": {"isEnabled": true,
"cooldown": 180,
"resourceLimits": {"maxMemoryGib": 1500,
"maxVCpu": 750
},
"down": {"maxScaleDownPercentage": 60
},
"headroom": {"cpuPerUnit": 2000,
"memoryPerUnit": 0,
"gpuPerUnit": 0,
"numOfUnits": 4
},
"isAutoConfig": false,
"autoHeadroomPercentage": null,
"enableAutomaticAndManualHeadroom": true,
"extendedResourceDefinitions": ["erd-123",
"erd-456"
]
},
"capacity": {"minimum": 0,
"maximum": 1000,
"target": 1
},
"strategy": {"utilizeReservedInstances": true,
"fallbackToOd": true,
"spotPercentage": 100,
"gracePeriod": 600,
"drainingTimeout": 60,
"utilizeCommitments": false
},
"scheduling": {"tasks": [{"isEnabled": true,
"cronExpression": "0 1 * * *",
"taskType": "clusterRoll",
"parameters": {"clusterRoll": {"batchSizePercentage": 20,
"comment": "This is why I deployed my cluster.",
"batchMinHealthyPercentage": 100
}
}
}
],
"shutdownHours": {"timeWindows": ["Sat:08:00-Sun:08:00"
],
"isEnabled": true
}
},
"security": {"containerImage": {"approvedImages": [["*.ecr.*.amazonaws.com/*",
"docker.*"
]
]
}
},
"compute": {"subnetIds": ["subnet-4c1d1538",
"subnet-2791bb61"
],
"instanceTypes": {"whitelist": ["c4.xlarge",
"c4.2xlarge",
"c4.4xlarge",
"c4.8xlarge"
],
"blacklist": ["r5.large",
"r5.xlarge"
]
},
"launchSpecification": {"useAsTemplateOnly": false,
"imageId": "string",
"userData": "string",
"securityGroupIds": [["sg-c3d914b0"
]
],
"iamInstanceProfile": {"arn": "orform"
},
"keyPair": "spotinst-labs-oregon",
"tags": [{"tagKey": "Creator",
"tagValue": "John Doe"
}
],
"loadBalancers": [{"type": "TARGET_GROUP",
"name": "MyTargetGroup",
"arn": "arn:aws:elasticloadbalancing:us-west-2:922761411234:targetgroup"
}
],
"associatePublicIpAddress": false,
"associateIpv6Address": false,
"monitoring": true,
"ebsOptimized": true,
"rootVolumeSize": 73,
"instanceMetadataOptions": {"httpTokens": "optional",
"httpPutResponseHopLimit": 12,
"httpEndpoint": "disabled"
}
}
},
"logging": {"export": {"s3": {"id": "di-123"
}
}
},
"createdAt": "2021-03-17T08:13:08.000Z",
"updatedAt": "2021-03-17T15:06:13.000Z"
}
],
"count": 1,
"kind": "spotinst:ocean:aws:k8s"
}
}

List Clusters

List the configurations for all Ocean clusters in the specified account.

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/aws/k8s/cluster",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "o-abcd1234",
"name": "oceanName",
"controllerClusterId": "ocean.k8s",
"region": "us-east-1",
"autoScaler": {"isEnabled": true,
"cooldown": 180,
"resourceLimits": {"maxMemoryGib": 1500,
"maxVCpu": 750
},
"down": {"maxScaleDownPercentage": 60
},
"headroom": {"cpuPerUnit": 2000,
"memoryPerUnit": 0,
"gpuPerUnit": 0,
"numOfUnits": 4
},
"isAutoConfig": false,
"autoHeadroomPercentage": null,
"enableAutomaticAndManualHeadroom": true,
"extendedResourceDefinitions": ["erd-123",
"erd-456"
]
},
"capacity": {"minimum": 0,
"maximum": 1000,
"target": 1
},
"strategy": {"utilizeReservedInstances": true,
"fallbackToOd": true,
"spotPercentage": 100,
"gracePeriod": 600,
"drainingTimeout": 60,
"utilizeCommitments": false
},
"scheduling": {"tasks": [{"isEnabled": true,
"cronExpression": "0 1 * * *",
"taskType": "clusterRoll",
"parameters": {"clusterRoll": {"batchSizePercentage": 20,
"comment": "This is why I deployed my cluster.",
"batchMinHealthyPercentage": 100
}
}
}
],
"shutdownHours": {"timeWindows": ["Sat:08:00-Sun:08:00"
],
"isEnabled": true
}
},
"security": {"containerImage": {"approvedImages": [["*.ecr.*.amazonaws.com/*",
"docker.*"
]
]
}
},
"compute": {"subnetIds": ["subnet-4c1d1538",
"subnet-2791bb61"
],
"instanceTypes": {"whitelist": ["c4.xlarge",
"c4.2xlarge",
"c4.4xlarge",
"c4.8xlarge"
],
"blacklist": ["r5.large",
"r5.xlarge"
]
},
"launchSpecification": {"useAsTemplateOnly": false,
"imageId": "string",
"userData": "string",
"securityGroupIds": [["sg-c3d914b0"
]
],
"iamInstanceProfile": {"arn": "orform"
},
"keyPair": "spotinst-labs-oregon",
"tags": [{"tagKey": "Creator",
"tagValue": "John Doe"
}
],
"loadBalancers": [{"type": "TARGET_GROUP",
"name": "MyTargetGroup",
"arn": "arn:aws:elasticloadbalancing:us-west-2:922761411234:targetgroup"
}
],
"associatePublicIpAddress": false,
"associateIpv6Address": false,
"monitoring": true,
"ebsOptimized": true,
"rootVolumeSize": 73,
"instanceMetadataOptions": {"httpTokens": "optional",
"httpPutResponseHopLimit": 12,
"httpEndpoint": "disabled"
}
}
},
"logging": {"export": {"s3": {"id": "di-123"
}
}
},
"createdAt": "2021-03-17T08:13:08.000Z",
"updatedAt": "2021-03-17T15:06:13.000Z"
}
],
"count": 1,
"kind": "spotinst:ocean:aws:k8s"
}
}

Delete Cluster

Delete an existing Ocean cluster.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-abcd1234

Identifier of the Ocean cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/aws/k8s/cluster/o-abcd1234",
"method": "DELETE",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Get Cluster

Get the configuration of an existing Ocean cluster.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-abcd1234

Identifier of the Ocean cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/aws/k8s/cluster/o-abcd1234",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "o-abcd1234",
"name": "oceanName",
"controllerClusterId": "ocean.k8s",
"region": "us-east-1",
"autoScaler": {"isEnabled": true,
"cooldown": 180,
"resourceLimits": {"maxMemoryGib": 1500,
"maxVCpu": 750
},
"down": {"maxScaleDownPercentage": 60
},
"headroom": {"cpuPerUnit": 2000,
"memoryPerUnit": 0,
"gpuPerUnit": 0,
"numOfUnits": 4
},
"isAutoConfig": false,
"autoHeadroomPercentage": null,
"enableAutomaticAndManualHeadroom": true,
"extendedResourceDefinitions": ["erd-123",
"erd-456"
]
},
"capacity": {"minimum": 0,
"maximum": 1000,
"target": 1
},
"strategy": {"utilizeReservedInstances": true,
"fallbackToOd": true,
"spotPercentage": 100,
"gracePeriod": 600,
"drainingTimeout": 60,
"utilizeCommitments": false
},
"scheduling": {"tasks": [{"isEnabled": true,
"cronExpression": "0 1 * * *",
"taskType": "clusterRoll",
"parameters": {"clusterRoll": {"batchSizePercentage": 20,
"comment": "This is why I deployed my cluster.",
"batchMinHealthyPercentage": 100
}
}
}
],
"shutdownHours": {"timeWindows": ["Sat:08:00-Sun:08:00"
],
"isEnabled": true
}
},
"security": {"containerImage": {"approvedImages": [["*.ecr.*.amazonaws.com/*",
"docker.*"
]
]
}
},
"compute": {"subnetIds": ["subnet-4c1d1538",
"subnet-2791bb61"
],
"instanceTypes": {"whitelist": ["c4.xlarge",
"c4.2xlarge",
"c4.4xlarge",
"c4.8xlarge"
],
"blacklist": ["r5.large",
"r5.xlarge"
]
},
"launchSpecification": {"useAsTemplateOnly": false,
"imageId": "string",
"userData": "string",
"securityGroupIds": [["sg-c3d914b0"
]
],
"iamInstanceProfile": {"arn": "orform"
},
"keyPair": "spotinst-labs-oregon",
"tags": [{"tagKey": "Creator",
"tagValue": "John Doe"
}
],
"loadBalancers": [{"type": "TARGET_GROUP",
"name": "MyTargetGroup",
"arn": "arn:aws:elasticloadbalancing:us-west-2:922761411234:targetgroup"
}
],
"associatePublicIpAddress": false,
"associateIpv6Address": false,
"monitoring": true,
"ebsOptimized": true,
"rootVolumeSize": 73,
"instanceMetadataOptions": {"httpTokens": "optional",
"httpPutResponseHopLimit": 12,
"httpEndpoint": "disabled"
}
}
},
"logging": {"export": {"s3": {"id": "di-123"
}
}
},
"createdAt": "2021-03-17T08:13:08.000Z",
"updatedAt": "2021-03-17T15:06:13.000Z"
}
],
"count": 1,
"kind": "spotinst:ocean:aws:k8s"
}
}

Update Cluster

All Ocean parameters are updatable, except for region and identifier. This API supports partial updates, so specific fields can be updated separately.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-abcd1234

Identifier of the Ocean cluster.

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
autoApplyTags	string Default: "false" Example: autoApplyTags=true Option to update instance tags on the fly without rolling the cluster.

Request Body schema: application/json

required

object (AWS Cluster)

The object specifying the configuration of the Ocean cluster.

	object (auto-scaler) The automatic scaling mechanism used in Ocean for Kubernetes.
	object (Capacity Units) The overall capability of the Ocean cluster expressed as number of instances and specified with a minimum, a maximum, and a target number of running instances.
	object (Ocean Compute) Compute specifications for the Ocean cluster.
controllerClusterId required	string Enter the reporting identifier for the Ocean Controller.
	object (Logging configuration)
name required	string Add a name for the Ocean cluster.
region required	string Select the region for the Ocean cluster to run in.
	object (Elastigroup Scheduling) An object used to define times for a task such as a shutdown to be activated.
	object (Security) Object for cluster security features.
	object (Ocean Cluster Strategy) An object defining the cluster strategy with regard to waiting periods and utilization of on-demand and reserved instances.

Responses

Request samples

Payload

Content type

application/json

{"cluster": {"name": "oceanName",
"controllerClusterId": "ocean.k8s",
"region": "us-east-1",
"autoScaler": {"isEnabled": true,
"cooldown": 180,
"resourceLimits": {"maxMemoryGib": 1500,
"maxVCpu": 750
},
"down": {"maxScaleDownPercentage": 60
},
"headroom": {"cpuPerUnit": 2000,
"memoryPerUnit": 0,
"gpuPerUnit": 0,
"numOfUnits": 4
},
"isAutoConfig": false,
"autoHeadroomPercentage": null,
"enableAutomaticAndManualHeadroom": true,
"extendedResourceDefinitions": ["erd-123",
"erd-456"
]
},
"capacity": {"minimum": 0,
"maximum": 1000,
"target": 1
},
"strategy": {"utilizeReservedInstances": true,
"fallbackToOd": true,
"spotPercentage": 100,
"gracePeriod": 600,
"drainingTimeout": 60,
"utilizeCommitments": false
},
"scheduling": {"tasks": [{"isEnabled": true,
"cronExpression": "0 1 * * *",
"taskType": "clusterRoll",
"parameters": {"clusterRoll": {"batchSizePercentage": 20,
"comment": "This is why I deployed my cluster.",
"batchMinHealthyPercentage": 100
}
}
}
],
"shutdownHours": {"timeWindows": ["Sat:08:00-Sun:08:00"
],
"isEnabled": true
}
},
"security": {"containerImage": {"approvedImages": [["*.ecr.*.amazonaws.com/*",
"docker.*"
]
]
}
},
"compute": {"subnetIds": ["subnet-4c1d1538",
"subnet-2791bb61"
],
"instanceTypes": {"whitelist": ["c4.xlarge",
"c4.2xlarge",
"c4.4xlarge",
"c4.8xlarge"
],
"blacklist": ["r5.large",
"r5.xlarge"
]
},
"launchSpecification": {"useAsTemplateOnly": false,
"imageId": "string",
"userData": "string",
"securityGroupIds": [["sg-c3d914b0"
]
],
"iamInstanceProfile": {"arn": "orform"
},
"keyPair": "spotinst-labs-oregon",
"tags": [{"tagKey": "Creator",
"tagValue": "John Doe"
}
],
"loadBalancers": [{"type": "TARGET_GROUP",
"name": "MyTargetGroup",
"arn": "arn:aws:elasticloadbalancing:us-west-2:922761411234:targetgroup"
}
],
"associatePublicIpAddress": false,
"associateIpv6Address": false,
"monitoring": true,
"ebsOptimized": true,
"rootVolumeSize": 73,
"instanceMetadataOptions": {"httpTokens": "optional",
"httpPutResponseHopLimit": 12,
"httpEndpoint": "disabled"
}
}
},
"logging": {"export": {"s3": {"id": "di-123"
}
}
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/aws/k8s/cluster/o-abcd1234",
"method": "PUT",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "o-abcd1234",
"name": "oceanName",
"controllerClusterId": "ocean.k8s",
"region": "us-east-1",
"autoScaler": {"isEnabled": true,
"cooldown": 180,
"resourceLimits": {"maxMemoryGib": 1500,
"maxVCpu": 750
},
"down": {"maxScaleDownPercentage": 60
},
"headroom": {"cpuPerUnit": 2000,
"memoryPerUnit": 0,
"gpuPerUnit": 0,
"numOfUnits": 4
},
"isAutoConfig": false,
"autoHeadroomPercentage": null,
"enableAutomaticAndManualHeadroom": true,
"extendedResourceDefinitions": ["erd-123",
"erd-456"
]
},
"capacity": {"minimum": 0,
"maximum": 1000,
"target": 1
},
"strategy": {"utilizeReservedInstances": true,
"fallbackToOd": true,
"spotPercentage": 100,
"gracePeriod": 600,
"drainingTimeout": 60,
"utilizeCommitments": false
},
"scheduling": {"tasks": [{"isEnabled": true,
"cronExpression": "0 1 * * *",
"taskType": "clusterRoll",
"parameters": {"clusterRoll": {"batchSizePercentage": 20,
"comment": "This is why I deployed my cluster.",
"batchMinHealthyPercentage": 100
}
}
}
],
"shutdownHours": {"timeWindows": ["Sat:08:00-Sun:08:00"
],
"isEnabled": true
}
},
"security": {"containerImage": {"approvedImages": [["*.ecr.*.amazonaws.com/*",
"docker.*"
]
]
}
},
"compute": {"subnetIds": ["subnet-4c1d1538",
"subnet-2791bb61"
],
"instanceTypes": {"whitelist": ["c4.xlarge",
"c4.2xlarge",
"c4.4xlarge",
"c4.8xlarge"
],
"blacklist": ["r5.large",
"r5.xlarge"
]
},
"launchSpecification": {"useAsTemplateOnly": false,
"imageId": "string",
"userData": "string",
"securityGroupIds": [["sg-c3d914b0"
]
],
"iamInstanceProfile": {"arn": "orform"
},
"keyPair": "spotinst-labs-oregon",
"tags": [{"tagKey": "Creator",
"tagValue": "John Doe"
}
],
"loadBalancers": [{"type": "TARGET_GROUP",
"name": "MyTargetGroup",
"arn": "arn:aws:elasticloadbalancing:us-west-2:922761411234:targetgroup"
}
],
"associatePublicIpAddress": false,
"associateIpv6Address": false,
"monitoring": true,
"ebsOptimized": true,
"rootVolumeSize": 73,
"instanceMetadataOptions": {"httpTokens": "optional",
"httpPutResponseHopLimit": 12,
"httpEndpoint": "disabled"
}
}
},
"logging": {"export": {"s3": {"id": "di-123"
}
}
},
"createdAt": "2021-03-17T08:13:08.000Z",
"updatedAt": "2021-03-17T15:06:13.000Z"
}
],
"count": 1,
"kind": "spotinst:ocean:aws:k8s"
}
}

Get Heartbeat Status

Get the heartbeat status of the Ocean Controller for the cluster.
The response returns the heartbeat status and the last heartbeat timestamp.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-abcd1234

Identifier of the Ocean cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/k8s/cluster/o-e0a2bd7c/controllerHeartbeat",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"status": "ACTIVE",
"lastHeartbeat": "2019-11-24T14:33:00.746Z"
}
],
"count": 1,
"kind": "spotinst:ocean:k8s:cluster:controllerHeartbeat"
}
}

Fetch Elastilog

Fetch the log of an Ocean cluster.

Authorizations:

path Parameters

clusterIdentifier

required

string

Example: o-6e3819ae

The reporting identifier of the Ocean Controller.

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
fromDate required	string Beginning date value using either the date format "yyyy-mm-dd; 2016-11-20" or ms "1494751821472".
LIMIT	integer <= 1000 Default: 500 Example: LIMIT=200 Maximum number of lines to extract in a response.
resourceId	string Example: resourceId=i-12345678 Filter extracted log entries for a specific resource identifier. Default: Null
SEVERITY	string Default: "ALL" Enum: "ALL" "INFO" "DEBUG" "WARN" Example: SEVERITY=INFO Severity of log entries to extract.
toDate required	string End date value using either the date format "yyyy-mm-dd; 2016-11-20" or ms "1494751821472".

Responses

Response samples

Content type

application/json

{"request": {"id": "3213f42e-455e-4801-a185-cd3eb65fac5f",
"url": "/ocean/aws/k8s/cluster/o-e0a2bd7c/log?fromDate=2020-10-06&toDate=2020-10-08&severity=ALL&limit=500",
"method": "GET",
"timestamp": "2020-10-05T16:20:38.579Z"
},
"response": {"status": {"code": "200",
"message": "OK"
},
"kind": "spotinst:ocean:cluster:log",
"items": [{"message": "Ocean o-e0a2bd7c successfully created.",
"severity": "INFO",
"createdAt": "2020-10-07T09:51:12.000Z"
}
],
"count": "1"
}
}

Import ASG To Ocean Cluster

Create an Ocean configuration according to an AWS autoscaling group (ASG) configuration.

Authorizations:

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
autoScalingGroupName required	string Example: autoScalingGroupName=myAutoScalingGroup The ASG name.
region required	string Example: region=us-east-1 Region name of the ASG.

Request Body schema: application/json

object

The object specifying the configuration of the VNG.

instanceTypes

Array of strings

List of possible instance types for the cluster.

Responses

Request samples

Payload

Content type

application/json

{"launchSpec": {"instanceTypes": ["c3.large",
"m4.large"
]
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/aws/k8s/cluster/autoScalingGroup/import",
"method": "POST",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"name": "TestASG1",
"controllerClusterId": "ocean-ed609402-8557-4d18-818a-e549333cc11e",
"region": "us-west-2",
"capacity": {"minimum": 0,
"maximum": 1000,
"target": 1
},
"compute": {"subnetIds": [["subnet-00cab2dd9f40a9883",
"subnet-0df9d512c7cbbd9e1"
]
],
"launchSpecification": {"securityGroupIds": [["sg-03ccf232a2bf0f4ea"
]
],
"keyPair": "testteamkp",
"imageId": "ami-0ce21b51cb31a54b8",
"tags": {"tagKey": "AmazonECSManaged",
"tagValue": ""
},
"associatePublicIpAddress": "false",
"instanceMetadataOptions": {"httpTokens": "optional",
"httpPutResponseHopLimit": 12,
"httpEndpoint": "disabled"
}
}
}
}
],
"count": 1,
"kind": "spotinst:ocean:aws:k8s"
}
}

Fetch Right Sizing Recommendations

Get right-sizing recommendations for an Ocean cluster and filter them according to namespace or label.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-12345abc

Identifier of the Ocean cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

object

Optional - may be null.

	object Optional - may be null.
namespaces	Array of strings Optional - may be null. If exists - should contain at least 1 item.

Responses

Request samples

Payload

Content type

application/json

{"filter": {"namespaces": ["sparkSpace",
"kube-system"
],
"attribute": {"type": "label",
"key": "app",
"operator": "Equals",
"value": "redis"
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/aws/k8s/cluster/o-abcd1234/rightSizing/suggestion",
"method": "POST",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"resourceName": "redis-controller",
"resourceType": "deployment",
"namespace": "kube-system",
"suggestedCPU": 4,
"suggestedMemory": 19,
"requestedCPU": 50,
"requestedMemory": 50,
"containers": [{"name": "dnsmasq",
"requestedCPU": 10,
"suggestedCPU": 2,
"requestedMemory": 40,
"suggestedMemory": 15
},
{"name": "sidecar",
"requestedCPU": 40,
"suggestedCPU": 2,
"requestedMemory": 10,
"suggestedMemory": 4
}
]
},
{"resourceName": "test-redis",
"resourceType": "deployment",
"namespace": "sparkSpace",
"suggestedCPU": 2,
"suggestedMemory": 20,
"requestedCPU": 50,
"requestedMemory": 30,
"containers": [{"name": "dns-controller",
"requestedCPU": 20,
"suggestedCPU": 1,
"requestedMemory": 20,
"suggestedMemory": 15
},
{"name": "kubedns",
"requestedCPU": 30,
"suggestedCPU": 1,
"requestedMemory": 10,
"suggestedMemory": 5
}
]
}
],
"count": 2,
"kind": "spotinst:ocean:aws:k8s:cluster:rightSizing:suggestion"
}
}

Attach Load Balancers

Add new load balancers to the existing load balancers on the Ocean Cluster.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-12345abc

Identifier of the Ocean cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

required

Array of objects (ocean-lb) [ items ]

Load balancers to add to the Ocean cluster.

Array

arn	string If type is "TARGET_GROUP" then an ARN is required. Otherwise is not allowed.
name	string If type is "CLASSIC" then a name is required. Otherwise is not allowed.
type required	string Enum: "CLASSIC" "TARGET_GROUP" Type of load balancer to use.

Responses

Request samples

Payload

Content type

application/json

{"loadBalancers": [{"type": "TARGET_GROUP",
"name": "MyTargetGroup",
"arn": "arn:aws:elasticloadbalancing:us-west-2:922761411234:targetgroup"
}
]
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/aws/k8s/cluster/o-12345abc/loadBalancer/attach",
"method": "PUT",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "o-abcd1234",
"name": "oceanName",
"controllerClusterId": "ocean.k8s",
"region": "us-east-1",
"autoScaler": {"isEnabled": true,
"cooldown": 180,
"resourceLimits": {"maxMemoryGib": 1500,
"maxVCpu": 750
},
"down": {"maxScaleDownPercentage": 60
},
"headroom": {"cpuPerUnit": 2000,
"memoryPerUnit": 0,
"gpuPerUnit": 0,
"numOfUnits": 4
},
"isAutoConfig": false,
"autoHeadroomPercentage": null,
"enableAutomaticAndManualHeadroom": true,
"extendedResourceDefinitions": ["erd-123",
"erd-456"
]
},
"capacity": {"minimum": 0,
"maximum": 1000,
"target": 1
},
"strategy": {"utilizeReservedInstances": true,
"fallbackToOd": true,
"spotPercentage": 100,
"gracePeriod": 600,
"drainingTimeout": 60,
"utilizeCommitments": false
},
"scheduling": {"tasks": [{"isEnabled": true,
"cronExpression": "0 1 * * *",
"taskType": "clusterRoll",
"parameters": {"clusterRoll": {"batchSizePercentage": 20,
"comment": "This is why I deployed my cluster.",
"batchMinHealthyPercentage": 100
}
}
}
],
"shutdownHours": {"timeWindows": ["Sat:08:00-Sun:08:00"
],
"isEnabled": true
}
},
"security": {"containerImage": {"approvedImages": [["*.ecr.*.amazonaws.com/*",
"docker.*"
]
]
}
},
"compute": {"subnetIds": ["subnet-4c1d1538",
"subnet-2791bb61"
],
"instanceTypes": {"whitelist": ["c4.xlarge",
"c4.2xlarge",
"c4.4xlarge",
"c4.8xlarge"
],
"blacklist": ["r5.large",
"r5.xlarge"
]
},
"launchSpecification": {"useAsTemplateOnly": false,
"imageId": "string",
"userData": "string",
"securityGroupIds": [["sg-c3d914b0"
]
],
"iamInstanceProfile": {"arn": "orform"
},
"keyPair": "spotinst-labs-oregon",
"tags": [{"tagKey": "Creator",
"tagValue": "John Doe"
}
],
"loadBalancers": [{"type": "TARGET_GROUP",
"name": "MyTargetGroup",
"arn": "arn:aws:elasticloadbalancing:us-west-2:922761411234:targetgroup"
}
],
"associatePublicIpAddress": false,
"associateIpv6Address": false,
"monitoring": true,
"ebsOptimized": true,
"rootVolumeSize": 73,
"instanceMetadataOptions": {"httpTokens": "optional",
"httpPutResponseHopLimit": 12,
"httpEndpoint": "disabled"
}
}
},
"logging": {"export": {"s3": {"id": "di-123"
}
}
},
"createdAt": "2021-03-17T08:13:08.000Z",
"updatedAt": "2021-03-17T15:06:13.000Z"
}
],
"count": 1,
"kind": "spotinst:ocean:aws:k8s"
}
}

Detach Load Balancers

Remove load balancers from the existing load balancers on the Ocean Cluster.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-12345abc

Identifier of the Ocean cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

required

Array of objects (ocean-lb) [ items ]

Load balancers to remove from the Ocean cluster.

Array

arn	string If type is "TARGET_GROUP" then an ARN is required. Otherwise is not allowed.
name	string If type is "CLASSIC" then a name is required. Otherwise is not allowed.
type required	string Enum: "CLASSIC" "TARGET_GROUP" Type of load balancer to use.

Responses

Request samples

Payload

Content type

application/json

{"loadBalancers": [{"type": "TARGET_GROUP",
"name": "MyTargetGroup",
"arn": "arn:aws:elasticloadbalancing:us-west-2:922761411234:targetgroup"
}
]
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/aws/k8s/cluster/o-12345abc/loadBalancer/detach",
"method": "PUT",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "o-abcd1234",
"name": "oceanName",
"controllerClusterId": "ocean.k8s",
"region": "us-east-1",
"autoScaler": {"isEnabled": true,
"cooldown": 180,
"resourceLimits": {"maxMemoryGib": 1500,
"maxVCpu": 750
},
"down": {"maxScaleDownPercentage": 60
},
"headroom": {"cpuPerUnit": 2000,
"memoryPerUnit": 0,
"gpuPerUnit": 0,
"numOfUnits": 4
},
"isAutoConfig": false,
"autoHeadroomPercentage": null,
"enableAutomaticAndManualHeadroom": true,
"extendedResourceDefinitions": ["erd-123",
"erd-456"
]
},
"capacity": {"minimum": 0,
"maximum": 1000,
"target": 1
},
"strategy": {"utilizeReservedInstances": true,
"fallbackToOd": true,
"spotPercentage": 100,
"gracePeriod": 600,
"drainingTimeout": 60,
"utilizeCommitments": false
},
"scheduling": {"tasks": [{"isEnabled": true,
"cronExpression": "0 1 * * *",
"taskType": "clusterRoll",
"parameters": {"clusterRoll": {"batchSizePercentage": 20,
"comment": "This is why I deployed my cluster.",
"batchMinHealthyPercentage": 100
}
}
}
],
"shutdownHours": {"timeWindows": ["Sat:08:00-Sun:08:00"
],
"isEnabled": true
}
},
"security": {"containerImage": {"approvedImages": [["*.ecr.*.amazonaws.com/*",
"docker.*"
]
]
}
},
"compute": {"subnetIds": ["subnet-4c1d1538",
"subnet-2791bb61"
],
"instanceTypes": {"whitelist": ["c4.xlarge",
"c4.2xlarge",
"c4.4xlarge",
"c4.8xlarge"
],
"blacklist": ["r5.large",
"r5.xlarge"
]
},
"launchSpecification": {"useAsTemplateOnly": false,
"imageId": "string",
"userData": "string",
"securityGroupIds": [["sg-c3d914b0"
]
],
"iamInstanceProfile": {"arn": "orform"
},
"keyPair": "spotinst-labs-oregon",
"tags": [{"tagKey": "Creator",
"tagValue": "John Doe"
}
],
"loadBalancers": [{"type": "TARGET_GROUP",
"name": "MyTargetGroup",
"arn": "arn:aws:elasticloadbalancing:us-west-2:922761411234:targetgroup"
}
],
"associatePublicIpAddress": false,
"associateIpv6Address": false,
"monitoring": true,
"ebsOptimized": true,
"rootVolumeSize": 73,
"instanceMetadataOptions": {"httpTokens": "optional",
"httpPutResponseHopLimit": 12,
"httpEndpoint": "disabled"
}
}
},
"logging": {"export": {"s3": {"id": "di-123"
}
}
},
"createdAt": "2021-03-17T08:13:08.000Z",
"updatedAt": "2021-03-17T15:06:13.000Z"
}
],
"count": 1,
"kind": "spotinst:ocean:aws:k8s"
}
}

Get Cluster Costs

Describes Kubernetes cluster costs in a time range based on resource allocation.
The response will provide the distribution of the costs per cluster, namespace, and deployment.
For each entity, the response will contain a breakdown to compute and EBS costs as well.
In addition, the response will show labels or annotations for each namespace or deployment so you can filter costs by labels or annotations.

Authorizations:

path Parameters

clusterIdentifier

required

string

Example: ocean.k8s

The reporting identifier of the Ocean Controller as set in the cluster configuration under the "controllerClusterId" field.

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
aggregationPeriod	string The time segment over which data is calculated and displayed. The period may be "daily" or null. If you use "daily" the costs will be broken into parts, e.g., the cost per each day in the period. Otherwise, there will be only one cost per resource for the whole period.
fromDate required	string Beginning date value using either the date format "yyyy-mm-dd; 2016-11-20" or ms "1494751821472".
toDate required	string End date value using either the date format "yyyy-mm-dd; 2016-11-20" or ms "1494751821472".

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/mcs/kubernetes/cluster/my-cluster-identifier/costs",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"totalCost": 279.9907,
"totalComputeCost": 279.9907,
"totalEbsCost": 0,
"totalStorageCost": 0,
"namespaces": {"namespace": "default",
"cost": 18.00862,
"computeCost": 18.00862,
"ebsCost": 0,
"storageCost": 0,
"labels": {"region": "west",
"env": "prod"
},
"annotations": {"region": "west",
"env": "prod"
},
"deployments": {"name": "cpu-deployment-check5",
"namespace": "default",
"cost": 3.7410312,
"computeCost": 3.7410312,
"ebsCost": 0,
"storageCost": 0,
"labels": {"region": "west",
"env": "prod"
},
"annotations": {"region": "west",
"env": "prod"
}
},
"statefulSets": {"name": "cpu-deployment-check5",
"namespace": "default",
"cost": 3.7410312,
"computeCost": 3.7410312,
"ebsCost": 0,
"storageCost": 0,
"labels": {"region": "west",
"env": "prod"
},
"annotations": {"region": "west",
"env": "prod"
}
},
"daemonSets": {"name": "cpu-deployment-check5",
"namespace": "default",
"cost": 3.7410312,
"computeCost": 3.7410312,
"ebsCost": 0,
"storageCost": 0,
"labels": {"region": "west",
"env": "prod"
},
"annotations": {"region": "west",
"env": "prod"
}
},
"jobs": {"name": "cpu-deployment-check5",
"namespace": "default",
"cost": 3.7410312,
"computeCost": 3.7410312,
"ebsCost": 0,
"storageCost": 0,
"labels": {"region": "west",
"env": "prod"
},
"annotations": {"region": "west",
"env": "prod"
}
},
"standAlonePodsCost": 0
},
"deployments": {"name": "cpu-deployment-check5",
"namespace": "default",
"cost": 3.7410312,
"computeCost": 3.7410312,
"ebsCost": 0,
"storageCost": 0,
"labels": {"region": "west",
"env": "prod"
},
"annotations": {"region": "west",
"env": "prod"
}
},
"headroomCost": 0,
"idleCost": 216.10321
}
],
"count": 1,
"kind": "string"
}
}

Upgrade Elastigroup To Ocean

Upgrade an Elastigroup with Kubernetes integration to Ocean for Kubernetes cluster.

Authorizations:

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
groupId required	string Elastigroup identifier

Responses

Response samples

Content type

application/json

{"kind": "spotinst:ocean:aws:k8s",
"items": {"id": "o-482d9d26",
"name": "Ocean::test-k8s-batch-1",
"clusterName": "testEnvironment_Batch_852a670a-aa73-3d5d-9576-147a26d43401",
"autoScaler": {"isEnabled": true,
"isAutoConfig": true
},
"region": "us-west-2",
"groupId": "sig-b6bb68fb",
"strategy": {"fallbackToOd": true,
"spotPercentage": 100,
"drainingTimeout": 120
},
"compute": {"subnetIds": ["subnet-4c1d1538",
"subnet-2791bb61"
],
"instanceTypes": {"whitelist": ["c4.xlarge",
"c4.2xlarge",
"c4.4xlarge",
"c4.8xlarge"
],
"blacklist": ["r5.large",
"r5.xlarge"
]
},
"launchSpecification": {"useAsTemplateOnly": false,
"imageId": "string",
"userData": "string",
"securityGroupIds": [["sg-c3d914b0"
]
],
"iamInstanceProfile": {"arn": "orform"
},
"keyPair": "spotinst-labs-oregon",
"tags": [{"tagKey": "Creator",
"tagValue": "John Doe"
}
],
"loadBalancers": [{"type": "TARGET_GROUP",
"name": "MyTargetGroup",
"arn": "arn:aws:elasticloadbalancing:us-west-2:922761411234:targetgroup"
}
],
"associatePublicIpAddress": false,
"associateIpv6Address": false,
"monitoring": true,
"ebsOptimized": true,
"rootVolumeSize": 73,
"instanceMetadataOptions": {"httpTokens": "optional",
"httpPutResponseHopLimit": 12,
"httpEndpoint": "disabled"
}
}
},
"createdAt": "2018-11-05T12:55:50.000+0000",
"updatedAt": "2018-11-05T12:58:15.000+0000"
}
}

Initiate Roll

Roll an entire Ocean cluster or roll subsets of the cluster by specifying launchSpecIds or instanceIds. Performing this request will start the roll immediately and run it in defined batches. Note that the first response for a successful request will indicate the start of a roll. In order to check the status of a roll, you can use the GET Roll API.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-abcd1234

Identifier of the Ocean cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

One of

object

batchMinHealthyPercentage	integer Default: 50 Indicates the threshold of minimum healthy instances in single batch. If the amount of healthy instances in single batch is under the threshold, the cluster roll will fail. If exists, the parameter value will be in range of 1-100. In case of null as value, the default value in the backend will be 50%. Value of param should represent the number in percentage (%) of the batch.
batchSizePercentage	integer Value as a percent to set the size of a batch in a roll. Valid values are 0-100.
comment	string Add a comment description for the roll. The comment is limited to 256 chars.
respectPdb	boolean Default: false During the roll, if the parameter is set to True we honor PDB during the instance replacement.

Responses

Request samples

Payload

Content type

application/json

Example

{"roll": {"batchSizePercentage": 20,
"comment": "This is why I deployed my cluster.",
"respectPdb": true,
"batchMinHealthyPercentage": 100
}
}

Response samples

Content type

application/json

{"id": "scr-5aaf854e",
"scope": "Cluster",
"status": "IN_PROGRESS",
"currentBatch": 1,
"numOfBatches": 5,
"comment": "This is why I deployed my cluster.",
"progress": {"unit": "percentage",
"value": 0,
"detailedStatus": {"oldInstances": [{"instanceId": "i-003a0281a24c01a20",
"status": "REPLACED"
},
{"instanceId": "i-003a0281a24c01a21",
"status": "TO_BE_REPLACED"
},
{"instanceId": "i-003a0281a24c01a22",
"status": "COULD_NOT_BE_REPLACED"
},
{"instanceId": "i-003a0281a24c01a23",
"status": "NOT_REPLACED_DUE_TO_PDB"
}
]
}
},
"oceanId": "o-12e31234",
"instanceIds": [["i-0003a99ffb566f039",
"i-0567a99ffb566f765"
]
],
"launchSpecIds": [["ols-76694a7d",
"ols-56694a76"
]
],
"respectPdb": true,
"batchMinHealthyPercentage": 100,
"createdAt": "2019-03-24T15:46:09.000Z",
"updatedAt": "2019-03-24T15:46:09.000Z"
}

List Rolls

Get status for all rolls of an Ocean cluster.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-1abcd124

The identifier of the Ocean cluster

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:ocean:aws:k8s:cluster:roll",
"items": [{"id": "scr-5aaf854e",
"scope": "Cluster",
"status": "IN_PROGRESS",
"currentBatch": 1,
"numOfBatches": 5,
"comment": "This is why I deployed my cluster.",
"progress": {"unit": "percentage",
"value": 0,
"detailedStatus": {"oldInstances": [{"instanceId": "i-003a0281a24c01a20",
"status": "REPLACED"
},
{"instanceId": "i-003a0281a24c01a21",
"status": "TO_BE_REPLACED"
},
{"instanceId": "i-003a0281a24c01a22",
"status": "COULD_NOT_BE_REPLACED"
},
{"instanceId": "i-003a0281a24c01a23",
"status": "NOT_REPLACED_DUE_TO_PDB"
}
]
}
},
"oceanId": "o-12e31234",
"instanceIds": [["i-0003a99ffb566f039",
"i-0567a99ffb566f765"
]
],
"launchSpecIds": [["ols-76694a7d",
"ols-56694a76"
]
],
"respectPdb": true,
"batchMinHealthyPercentage": 100,
"createdAt": "2019-03-24T15:46:09.000Z",
"updatedAt": "2019-03-24T15:46:09.000Z"
}
]
}

Update Roll

Update a roll of an Ocean cluster.

Performing the request will stop the next batch in a roll.

Authorizations:

path Parameters

oceanClusterId required	string Example: o-1abcd124 The identifier of the Ocean cluster
ROLL_ID required	string Example: scr-12345abc Ocean cluster roll identifier

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

object

Object that specifies the parameters required to initiate a roll (also called a deployment).

status

string

Value: "STOPPED"

Set status of a roll. Valid values: "STOPPED"

Responses

Request samples

Payload

Content type

application/json

{"roll": {"status": "STOPPED"
}
}

Response samples

Content type

application/json

{"id": "scr-5aaf854e",
"scope": "Cluster",
"status": "STOPPED",
"currentBatch": 1,
"numOfBatches": 5,
"progress": {"unit": "percentage",
"value": 0,
"detailedStatus": {"oldInstances": [{"instanceId": "i-003a0281a24c01a20",
"status": "REPLACED"
},
{"instanceId": "i-003a0281a24c01a21",
"status": "TO_BE_REPLACED"
},
{"instanceId": "i-003a0281a24c01a22",
"status": "COULD_NOT_BE_REPLACED"
},
{"instanceId": "i-003a0281a24c01a23",
"status": "NOT_REPLACED_DUE_TO_PDB"
}
]
}
},
"oceanId": "o-12e31234",
"respectPdb": true,
"batchMinHealthyPercentage": 100,
"createdAt": "2019-03-24T15:46:09.000Z",
"updatedAt": "2019-03-24T15:46:09.000Z"
}

Get Roll

Get status for a roll of an Ocean cluster.

Authorizations:

path Parameters

oceanClusterId required	string Example: o-1abcd124 The identifier of the Ocean cluster
ROLL_ID required	string Example: scr-12345abc Ocean Cluster Roll identifier

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"id": "scr-5aaf854e",
"scope": "Cluster",
"status": "IN_PROGRESS",
"currentBatch": 1,
"numOfBatches": 5,
"comment": "This is why I deployed my cluster.",
"progress": {"unit": "percentage",
"value": 0,
"detailedStatus": {"oldInstances": [{"instanceId": "i-003a0281a24c01a20",
"status": "REPLACED"
},
{"instanceId": "i-003a0281a24c01a21",
"status": "TO_BE_REPLACED"
},
{"instanceId": "i-003a0281a24c01a22",
"status": "COULD_NOT_BE_REPLACED"
},
{"instanceId": "i-003a0281a24c01a23",
"status": "NOT_REPLACED_DUE_TO_PDB"
}
]
}
},
"oceanId": "o-12e31234",
"instanceIds": [["i-0003a99ffb566f039",
"i-0567a99ffb566f765"
]
],
"launchSpecIds": [["ols-76694a7d",
"ols-56694a76"
]
],
"respectPdb": true,
"batchMinHealthyPercentage": 100,
"createdAt": "2019-03-24T15:46:09.000Z",
"updatedAt": "2019-03-24T15:46:09.000Z"
}

Get Cluster Nodes

Get nodes data of an Ocean cluster.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-12345abc

Identifier of the Ocean cluster.

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
instanceId	string Example: instanceId=i-123 Get a specific node by instance id.
launchSpecId	string Example: launchSpecId=ols-123abc Ocean cluster launch specification identifier.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/aws/k8s/cluster/o-12345abc/nodes",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"instanceId": "i-123",
"instanceType": "c3.large",
"availabilityZone": "us-west-2b",
"launchSpecId": "ols-123",
"launchSpecName": "dev-launchSpec",
"lifeCycle": "Spot",
"publicIp": "1.2.3.4",
"workloadRequestedMilliCpu": 1320,
"workloadRequestedMemoryInMiB": 500,
"workloadRequestedGpu": 1,
"headroomRequestedMilliCpu": 1320,
"headroomRequestedMemoryInMiB": 512,
"headroomRequestedGpu": 1,
"allocatableMilliCpu": 2000,
"allocatableMemoryInMiB": 3646.1,
"allocatableGpu": 1,
"nodeName": "node-1",
"registrationStatus": "Registered",
"createdAt": "2021-10-1T05:51:06.000Z"
}
],
"count": 1,
"kind": "spotinst:ocean:aws:k8s:nodes"
}
}

Detach Instances

Detach instances from your Ocean cluster.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-abcd1234

Identifier of the Ocean cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

instancesToDetach	Array of strings Array of instance identifiers to be detached.
shouldDecrementTargetCapacity	boolean Determines whether the Ocean cluster's target capacity should be decremented.
shouldTerminateInstances	boolean Determines whether the detached EC2 instances should be terminated or not.

Responses

Request samples

Payload

Content type

application/json

{"instancesToDetach": ["i-0003a99ffb566f039",
"i-0567a99ffb566f765"
],
"shouldTerminateInstances": true,
"shouldDecrementTargetCapacity": false
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/aws/k8s/cluster/o-abcd1234/detachInstances",
"method": "PUT",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Get Cluster Aggregated Detailed Costs

Provides Kubernetes cluster resource usage and costs over a time interval which can be grouped and/or filtered by label/annotaion,
for example - application name (webapp, backend), environment (production, staging), version etc.
The response will contain a breakdown of the cluster resource costs($) in terms of compute (CPU, memory), storage (block, file, rootVolume). The response will group the cluster usage costs based on preselected default of application namespace or user selected label or annotation.
Within the group, resource costs are broken down per resource kind (Deployment, DaemonSet etc.).

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-abcd1234

Identifier of the Ocean cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

endTime required	string End date value using either the date format "yyyy-MM-dd'T'HH:mm:ss'Z'" or ms "1494751821472".
	object Describe how to filter the costs. Optional field.
groupBy	string Default: "namespace" Enum: "namespace" "namespace.label.${labelKey}" "resource.label.${labelKey}" "resource.annotation.${annotationKey}" "namespace.annotation.${annotationKey}" The parameter we want to group the costs by.
startTime required	string Beginning date value using either the date format "yyyy-MM-dd'T'HH:mm:ss'Z'" or ms "1494751821472".

Responses

Request samples

Payload

Content type

application/json

{"startTime": "2018-06-20T11:35:02.745Z",
"endTime": "2018-06-22T11:30:01.745Z",
"groupBy": "namespace.label.env",
"filter": {"scope": "namespace",
"conditions": {"anyMatch": [{"allMatch": [{"type": "label",
"key": "env",
"operator": "equals",
"value": "prod"
},
{"type": "label",
"key": "app",
"operator": "exists"
}
]
},
{"allMatch": [{"type": "annotation",
"key": "meta.data",
"operator": "exists"
}
]
}
]
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/aws/k8s/cluster/o-abcd1234/aggregatedCosts",
"method": "POST",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"result": {"totalForDuration": {"startTime": "2018-06-20T11:35:01.745Z",
"endTime": "2018-06-22T11:30:01.745Z",
"summary": {"total": 41772.882658035785,
"compute": {"total": 40668.1299631538,
"workloads": {"total": 39882.13803327978
},
"headroom": {"total": 0
}
},
"storage": {"total": 1104.7526948819868,
"block": {"total": 1104.7526948819868,
"ebsPv": {"total": 1104.7526948819868
},
"nonPv": {"total": 0
}
},
"file": {"total": 0,
"efsPv": {"total": 0
}
}
}
},
"detailedCosts": {"groupedBy": "n.l.name",
"aggregations": {"property1": {"summary": {"total": 423.33455,
"compute": {"total": 125.23778
},
"storage": {"total": 307.09677,
"block": {"total": 300,
"ebsPv": {"total": 300
},
"nonPv": {"total": 0
}
},
"file": {"total": 7.09677,
"efsPv": {"total": 7.09677
}
}
}
},
"resources": [{"metadata": {"name": "k8s-events",
"type": "Deployment",
"namespace": "kube-system"
},
"total": 1.655635222089105,
"compute": {"total": 1.4213600158059045
},
"storage": {"total": 0.23427520628320053,
"block": {"total": 0.23427520628320053,
"ebsPv": {"total": 0
},
"nonPv": {"total": 0.23427520628320053
}
},
"file": {"total": 0,
"efsPv": {"total": 0
}
}
}
}
]
},
"property2": {"summary": {"total": 423.33455,
"compute": {"total": 125.23778
},
"storage": {"total": 307.09677,
"block": {"total": 300,
"ebsPv": {"total": 300
},
"nonPv": {"total": 0
}
},
"file": {"total": 7.09677,
"efsPv": {"total": 7.09677
}
}
}
},
"resources": [{"metadata": {"name": "k8s-events",
"type": "Deployment",
"namespace": "kube-system"
},
"total": 1.655635222089105,
"compute": {"total": 1.4213600158059045
},
"storage": {"total": 0.23427520628320053,
"block": {"total": 0.23427520628320053,
"ebsPv": {"total": 0
},
"nonPv": {"total": 0.23427520628320053
}
},
"file": {"total": 0,
"efsPv": {"total": 0
}
}
}
}
]
}
}
}
}
}
}
],
"count": 1,
"kind": "ocean:k8s:cluster:aggregatedCosts:detailed"
}
}

Create Virtual Node Group

Create a Virtual Node Group.

Authorizations:

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
initialNodes	integer Default: null Example: initialNodes=1 When set to an integer greater than 0, a corresponding number of nodes will be launched from the virtual node group created.

Request Body schema: application/json

required

object (oceanClusterLaunchSpecWithMetadata)

AWS Cluster Virtual Node Group (VNG).

associatePublicIpAddress	boolean Default: false Configure public IP address allocation.
	object Object specifying the automatic scaling of an Ocean VNG.
	Array of objects[ items ] Block devices that are exposed to the instance. You can specify virtual devices and EBS volumes. This parameter and rootVolumeSize cannot be in the spec at the same time. This parameter can be null, but if not null, it must contain at least one block device.
	object Assign an Elastic IP to the instances launched by the launch spec. Can be null.
	object (auto-scaler) The instance profile iamRole object.
imageId	string Set image identifier. Can be null.
	object (instanceMetadataOptions) Ocean instance metadata options object for IMDSv2.
instanceTypes	Array of strings A list of instance types allowed to be provisioned for pods pending for the launch specification. The list overrides the list defined for the Ocean cluster. Can be null.
	Array of objects[ items ] An array of labels to add to the VNG nodes. Only custom user labels are allowed, and not Kubernetes built-in labels or Spot internal labels.
name	string Set launch specification name.
oceanId required	string The Ocean cluster identifier. Required for Launch Spec creation.
preferredSpotTypes	Array of strings When Ocean scales up instances, it takes your preferred types into consideration while maintaining a variety of machine types running for optimized distribution. Learn More
	object
restrictScaleDown	boolean When set to “True”, VNG nodes will be treated as if all pods running have the restrict-scale-down label. Therefore, Ocean will not scale nodes down unless empty.
rootVolumeSize	integer Set root volume size (in GB). This field and blockDeviceMappings cannot be used in the same specification.
	object (Ocean Scheduling) An object used to define scheduled tasks such as a manual headroom update.
securityGroupIds	Array of strings Set security groups. Each element in the array is a security group identifier.
	object Similar to a strategy for an Ocean cluster, but applying only to a virtual node group.
subnetIds	Array of strings Set subnets in launchSpec. Each element in the array is a subnet identifier.
	Array of objects[ items ] List of kay-value pairs of tags.
	Array of objects[ items ] Add taints to Launch Spec.
userData	string Set user data script in base 64 encoded MIME.

Responses

Request samples

Payload

Content type

application/json

{"launchSpec": {"oceanId": "o-abcd1234",
"name": "specialty.nodes.spotk8s.com",
"imageId": "ami-ID",
"userData": "dsa89d7uosduxq98sau9s8aux9s8aux09q0qu09axsuix0s9qas09xz",
"iamInstanceProfile": {"arn": "arn:aws:iam::123456781234:instance-profile/EKS-nodes-test-NodeInstanceProfile-ABCDEFGH123",
"name": "EKS-nodes-test"
},
"securityGroupIds": ["sg-0ded3a2980208c30c",
"sg-0ded3a2980208c30d"
],
"instanceTypes": ["c3.2xlarge",
"c4.2xlarge"
],
"preferredSpotTypes": ["c3.2xlarge",
"c4.2xlarge"
],
"rootVolumeSize": 8,
"labels": [{"key": "env",
"value": "test"
}
],
"taints": [{"key": "taintKey",
"value": "taintValue",
"effect": "NoSchedule"
}
],
"subnetIds": ["subnet-123",
"subnet-456"
],
"elasticIpPool": {"tagSelector": {"tagKey": "color",
"tagValue": "orange"
}
},
"autoScale": {"headrooms": [{"cpuPerUnit": 1024,
"memoryPerUnit": 512,
"numOfUnits": 2,
"gpuPerUnit": 0
}
],
"autoHeadroomPercentage": 20,
"down": {"maxScaleDownPercentage": 30
}
},
"tags": [{"tagKey": "Creator",
"tagValue": "John Doe"
}
],
"blockDeviceMappings": [{"deviceName": "/dev/xvda",
"ebs": {"throughput": 125,
"deleteOnTermination": false,
"encrypted": false,
"iops": 1,
"kmsKeyId": "alias/aws/ebs",
"snapshotId": "snap-abcdefghi111110",
"volumeType": "gp2",
"volumeSize": 0,
"dynamicVolumeSize": {"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
}
}
}
],
"resourceLimits": {"maxInstanceCount": 5,
"minInstanceCount": 2
},
"strategy": {"spotPercentage": 70
},
"associatePublicIpAddress": false,
"restrictScaleDown": false,
"scheduling": {"tasks": [{"isEnabled": true,
"cronExpression": "0 1 * * *",
"taskType": "manualHeadroomUpdate",
"config": {"headrooms": [{"cpuPerUnit": 1024,
"memoryPerUnit": 512,
"numOfUnits": 2,
"gpuPerUnit": 1
}
]
}
}
],
"shutdownHours": {"timeWindows": ["Sat:08:00-Sun:08:00"
],
"isEnabled": true
}
},
"instanceMetadataOptions": {"httpTokens": "optional",
"httpPutResponseHopLimit": 12
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/aws/k8s/launchSpec",
"method": "POST",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "ols-12345abc",
"oceanId": "o-abcd1234",
"createdAt": "2021-03-17T08:13:08.000Z",
"updatedAt": "2021-03-17T15:06:13.000Z",
"name": "specialty.nodes.spotk8s.com",
"imageId": "ami-ID",
"userData": "dsa89d7uosduxq98sau9s8aux9s8aux09q0qu09axsuix0s9qas09xz",
"iamInstanceProfile": {"arn": "arn:aws:iam::123456781234:instance-profile/EKS-nodes-test-NodeInstanceProfile-ABCDEFGH123",
"name": "EKS-nodes-test"
},
"securityGroupIds": ["sg-0ded3a2980208c30c",
"sg-0ded3a2980208c30d"
],
"instanceTypes": ["c3.2xlarge",
"c4.2xlarge"
],
"preferredSpotTypes": ["c3.2xlarge",
"c4.2xlarge"
],
"rootVolumeSize": 8,
"labels": [{"key": "env",
"value": "test"
}
],
"taints": [{"key": "taintKey",
"value": "taintValue",
"effect": "NoSchedule"
}
],
"subnetIds": ["subnet-123",
"subnet-456"
],
"elasticIpPool": {"tagSelector": {"tagKey": "color",
"tagValue": "orange"
}
},
"autoScale": {"headrooms": [{"cpuPerUnit": 1024,
"memoryPerUnit": 512,
"numOfUnits": 2,
"gpuPerUnit": 0
}
],
"autoHeadroomPercentage": 20,
"down": {"maxScaleDownPercentage": 30
}
},
"tags": [{"tagKey": "Creator",
"tagValue": "John Doe"
}
],
"blockDeviceMappings": [{"deviceName": "/dev/xvda",
"ebs": {"throughput": 125,
"deleteOnTermination": false,
"encrypted": false,
"iops": 1,
"kmsKeyId": "alias/aws/ebs",
"snapshotId": "snap-abcdefghi111110",
"volumeType": "gp2",
"volumeSize": 0,
"dynamicVolumeSize": {"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
}
}
}
],
"resourceLimits": {"maxInstanceCount": 5,
"minInstanceCount": 2
},
"strategy": {"spotPercentage": 70
},
"associatePublicIpAddress": false,
"restrictScaleDown": false,
"scheduling": {"tasks": [{"isEnabled": true,
"cronExpression": "0 1 * * *",
"taskType": "manualHeadroomUpdate",
"config": {"headrooms": [{"cpuPerUnit": 1024,
"memoryPerUnit": 512,
"numOfUnits": 2,
"gpuPerUnit": 1
}
]
}
}
],
"shutdownHours": {"timeWindows": ["Sat:08:00-Sun:08:00"
],
"isEnabled": true
}
},
"instanceMetadataOptions": {"httpTokens": "optional",
"httpPutResponseHopLimit": 12
}
}
],
"count": 1,
"kind": "spotinst:ocean:aws:k8s:launchSpec"
}
}

List Virtual Node Groups

List the configurations of all virtual node groups for the cluster.

Authorizations:

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
oceanId required	string Example: oceanId=o-12345abc Identifier of the Ocean cluster.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/aws/k8s/launchSpec",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "ols-12345abc",
"oceanId": "o-abcd1234",
"createdAt": "2021-03-17T08:13:08.000Z",
"updatedAt": "2021-03-17T15:06:13.000Z",
"name": "specialty.nodes.spotk8s.com",
"imageId": "ami-ID",
"userData": "dsa89d7uosduxq98sau9s8aux9s8aux09q0qu09axsuix0s9qas09xz",
"iamInstanceProfile": {"arn": "arn:aws:iam::123456781234:instance-profile/EKS-nodes-test-NodeInstanceProfile-ABCDEFGH123",
"name": "EKS-nodes-test"
},
"securityGroupIds": ["sg-0ded3a2980208c30c",
"sg-0ded3a2980208c30d"
],
"instanceTypes": ["c3.2xlarge",
"c4.2xlarge"
],
"preferredSpotTypes": ["c3.2xlarge",
"c4.2xlarge"
],
"rootVolumeSize": 8,
"labels": [{"key": "env",
"value": "test"
}
],
"taints": [{"key": "taintKey",
"value": "taintValue",
"effect": "NoSchedule"
}
],
"subnetIds": ["subnet-123",
"subnet-456"
],
"elasticIpPool": {"tagSelector": {"tagKey": "color",
"tagValue": "orange"
}
},
"autoScale": {"headrooms": [{"cpuPerUnit": 1024,
"memoryPerUnit": 512,
"numOfUnits": 2,
"gpuPerUnit": 0
}
],
"autoHeadroomPercentage": 20,
"down": {"maxScaleDownPercentage": 30
}
},
"tags": [{"tagKey": "Creator",
"tagValue": "John Doe"
}
],
"blockDeviceMappings": [{"deviceName": "/dev/xvda",
"ebs": {"throughput": 125,
"deleteOnTermination": false,
"encrypted": false,
"iops": 1,
"kmsKeyId": "alias/aws/ebs",
"snapshotId": "snap-abcdefghi111110",
"volumeType": "gp2",
"volumeSize": 0,
"dynamicVolumeSize": {"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
}
}
}
],
"resourceLimits": {"maxInstanceCount": 5,
"minInstanceCount": 2
},
"strategy": {"spotPercentage": 70
},
"associatePublicIpAddress": false,
"restrictScaleDown": false,
"scheduling": {"tasks": [{"isEnabled": true,
"cronExpression": "0 1 * * *",
"taskType": "manualHeadroomUpdate",
"config": {"headrooms": [{"cpuPerUnit": 1024,
"memoryPerUnit": 512,
"numOfUnits": 2,
"gpuPerUnit": 1
}
]
}
}
],
"shutdownHours": {"timeWindows": ["Sat:08:00-Sun:08:00"
],
"isEnabled": true
}
},
"instanceMetadataOptions": {"httpTokens": "optional",
"httpPutResponseHopLimit": 12
}
}
],
"count": 1,
"kind": "spotinst:ocean:aws:k8s:launchSpec"
}
}

Delete Virtual Node Group

Delete a specified launch specification in an Ocean cluster.

Authorizations:

path Parameters

oceanLaunchSpecId

required

string

Ocean cluster launch specification identifier.

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
deleteNodes	boolean Default: false Example: deleteNodes=true When set to "true", all instances belonging to the deleted launch specification will be drained, detached, and terminated.
forceDelete	boolean Default: null Example: forceDelete=true When set to "true", delete even if it is the only custom launch spec remaining, and default launch spec has useAsTemlateOnly = true.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/aws/k8s/launchSpec/ols-12345abc",
"method": "DELETE",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Update Virtual Node Group

Update launch specification.

Authorizations:

path Parameters

oceanLaunchSpecId

required

string

Ocean cluster launch specification identifier.

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
autoApplyTags	boolean Default: false Example: autoApplyTags=true Optionally update resource tags on the fly without performing a roll.

Request Body schema: application/json

required

object (oceanClusterLaunchSpec-2)

AWS Cluster Virtual Node Group (VNG).

associatePublicIpAddress	boolean Default: false Configure public IP address allocation.
	object Object specifying the automatic scaling of an Ocean VNG.
	Array of objects[ items ] Block devices that are exposed to the instance. You can specify virtual devices and EBS volumes. This parameter and rootVolumeSize cannot be in the spec at the same time. This parameter can be null, but if not null, it must contain at least one block device.
	object Assign an Elastic IP to the instances launched by the launch spec. Can be null.
	object (auto-scaler) The instance profile iamRole object.
imageId	string Set image identifier. Can be null.
	object (instanceMetadataOptions) Ocean instance metadata options object for IMDSv2.
instanceTypes	Array of strings A list of instance types allowed to be provisioned for pods pending for the launch specification. The list overrides the list defined for the Ocean cluster. Can be null.
	Array of objects[ items ] An array of labels to add to the VNG nodes. Only custom user labels are allowed, and not Kubernetes built-in labels or Spot internal labels.
name	string Set launch specification name.
preferredSpotTypes	Array of strings When Ocean scales up instances, it takes your preferred types into consideration while maintaining a variety of machine types running for optimized distribution. Learn More
	object
restrictScaleDown	boolean When set to “True”, VNG nodes will be treated as if all pods running have the restrict-scale-down label. Therefore, Ocean will not scale nodes down unless empty.
rootVolumeSize	integer Set root volume size (in GB). This field and blockDeviceMappings cannot be used in the same specification.
	object (Ocean Scheduling) An object used to define scheduled tasks such as a manual headroom update.
securityGroupIds	Array of strings Set security groups. Each element in the array is a security group identifier.
	object Similar to a strategy for an Ocean cluster, but applying only to a virtual node group.
subnetIds	Array of strings Set subnets in launchSpec. Each element in the array is a subnet identifier.
	Array of objects[ items ] List of kay-value pairs of tags.
	Array of objects[ items ] Add taints to Launch Spec.
userData	string Set user data script in base 64 encoded MIME.

Responses

Request samples

Payload

Content type

application/json

{"launchSpec": {"name": "specialty.nodes.spotk8s.com",
"imageId": "ami-ID",
"userData": "dsa89d7uosduxq98sau9s8aux9s8aux09q0qu09axsuix0s9qas09xz",
"iamInstanceProfile": {"arn": "arn:aws:iam::123456781234:instance-profile/EKS-nodes-test-NodeInstanceProfile-ABCDEFGH123",
"name": "EKS-nodes-test"
},
"securityGroupIds": ["sg-0ded3a2980208c30c",
"sg-0ded3a2980208c30d"
],
"instanceTypes": ["c3.2xlarge",
"c4.2xlarge"
],
"preferredSpotTypes": ["c3.2xlarge",
"c4.2xlarge"
],
"rootVolumeSize": 8,
"labels": [{"key": "env",
"value": "test"
}
],
"taints": [{"key": "taintKey",
"value": "taintValue",
"effect": "NoSchedule"
}
],
"subnetIds": ["subnet-123",
"subnet-456"
],
"elasticIpPool": {"tagSelector": {"tagKey": "color",
"tagValue": "orange"
}
},
"autoScale": {"headrooms": [{"cpuPerUnit": 1024,
"memoryPerUnit": 512,
"numOfUnits": 2,
"gpuPerUnit": 0
}
],
"autoHeadroomPercentage": 20,
"down": {"maxScaleDownPercentage": 30
}
},
"tags": [{"tagKey": "Creator",
"tagValue": "John Doe"
}
],
"blockDeviceMappings": [{"deviceName": "/dev/xvda",
"ebs": {"throughput": 125,
"deleteOnTermination": false,
"encrypted": false,
"iops": 1,
"kmsKeyId": "alias/aws/ebs",
"snapshotId": "snap-abcdefghi111110",
"volumeType": "gp2",
"volumeSize": 0,
"dynamicVolumeSize": {"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
}
}
}
],
"resourceLimits": {"maxInstanceCount": 5,
"minInstanceCount": 2
},
"strategy": {"spotPercentage": 70
},
"associatePublicIpAddress": false,
"restrictScaleDown": false,
"scheduling": {"tasks": [{"isEnabled": true,
"cronExpression": "0 1 * * *",
"taskType": "manualHeadroomUpdate",
"config": {"headrooms": [{"cpuPerUnit": 1024,
"memoryPerUnit": 512,
"numOfUnits": 2,
"gpuPerUnit": 1
}
]
}
}
],
"shutdownHours": {"timeWindows": ["Sat:08:00-Sun:08:00"
],
"isEnabled": true
}
},
"instanceMetadataOptions": {"httpTokens": "optional",
"httpPutResponseHopLimit": 12
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/aws/k8s/launchSpec/ols-12345abc",
"method": "PUT",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "ols-12345abc",
"oceanId": "o-abcd1234",
"createdAt": "2021-03-17T08:13:08.000Z",
"updatedAt": "2021-03-17T15:06:13.000Z",
"name": "specialty.nodes.spotk8s.com",
"imageId": "ami-ID",
"userData": "dsa89d7uosduxq98sau9s8aux9s8aux09q0qu09axsuix0s9qas09xz",
"iamInstanceProfile": {"arn": "arn:aws:iam::123456781234:instance-profile/EKS-nodes-test-NodeInstanceProfile-ABCDEFGH123",
"name": "EKS-nodes-test"
},
"securityGroupIds": ["sg-0ded3a2980208c30c",
"sg-0ded3a2980208c30d"
],
"instanceTypes": ["c3.2xlarge",
"c4.2xlarge"
],
"preferredSpotTypes": ["c3.2xlarge",
"c4.2xlarge"
],
"rootVolumeSize": 8,
"labels": [{"key": "env",
"value": "test"
}
],
"taints": [{"key": "taintKey",
"value": "taintValue",
"effect": "NoSchedule"
}
],
"subnetIds": ["subnet-123",
"subnet-456"
],
"elasticIpPool": {"tagSelector": {"tagKey": "color",
"tagValue": "orange"
}
},
"autoScale": {"headrooms": [{"cpuPerUnit": 1024,
"memoryPerUnit": 512,
"numOfUnits": 2,
"gpuPerUnit": 0
}
],
"autoHeadroomPercentage": 20,
"down": {"maxScaleDownPercentage": 30
}
},
"tags": [{"tagKey": "Creator",
"tagValue": "John Doe"
}
],
"blockDeviceMappings": [{"deviceName": "/dev/xvda",
"ebs": {"throughput": 125,
"deleteOnTermination": false,
"encrypted": false,
"iops": 1,
"kmsKeyId": "alias/aws/ebs",
"snapshotId": "snap-abcdefghi111110",
"volumeType": "gp2",
"volumeSize": 0,
"dynamicVolumeSize": {"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
}
}
}
],
"resourceLimits": {"maxInstanceCount": 5,
"minInstanceCount": 2
},
"strategy": {"spotPercentage": 70
},
"associatePublicIpAddress": false,
"restrictScaleDown": false,
"scheduling": {"tasks": [{"isEnabled": true,
"cronExpression": "0 1 * * *",
"taskType": "manualHeadroomUpdate",
"config": {"headrooms": [{"cpuPerUnit": 1024,
"memoryPerUnit": 512,
"numOfUnits": 2,
"gpuPerUnit": 1
}
]
}
}
],
"shutdownHours": {"timeWindows": ["Sat:08:00-Sun:08:00"
],
"isEnabled": true
}
},
"instanceMetadataOptions": {"httpTokens": "optional",
"httpPutResponseHopLimit": 12
}
}
],
"count": 1,
"kind": "spotinst:ocean:aws:k8s:launchSpec"
}
}

Get Virtual Node Group

Authorizations:

path Parameters

oceanLaunchSpecId

required

string

Ocean cluster launch specification identifier.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/aws/k8s/launchSpec/ols-12345abc",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "ols-12345abc",
"oceanId": "o-abcd1234",
"createdAt": "2021-03-17T08:13:08.000Z",
"updatedAt": "2021-03-17T15:06:13.000Z",
"name": "specialty.nodes.spotk8s.com",
"imageId": "ami-ID",
"userData": "dsa89d7uosduxq98sau9s8aux9s8aux09q0qu09axsuix0s9qas09xz",
"iamInstanceProfile": {"arn": "arn:aws:iam::123456781234:instance-profile/EKS-nodes-test-NodeInstanceProfile-ABCDEFGH123",
"name": "EKS-nodes-test"
},
"securityGroupIds": ["sg-0ded3a2980208c30c",
"sg-0ded3a2980208c30d"
],
"instanceTypes": ["c3.2xlarge",
"c4.2xlarge"
],
"preferredSpotTypes": ["c3.2xlarge",
"c4.2xlarge"
],
"rootVolumeSize": 8,
"labels": [{"key": "env",
"value": "test"
}
],
"taints": [{"key": "taintKey",
"value": "taintValue",
"effect": "NoSchedule"
}
],
"subnetIds": ["subnet-123",
"subnet-456"
],
"elasticIpPool": {"tagSelector": {"tagKey": "color",
"tagValue": "orange"
}
},
"autoScale": {"headrooms": [{"cpuPerUnit": 1024,
"memoryPerUnit": 512,
"numOfUnits": 2,
"gpuPerUnit": 0
}
],
"autoHeadroomPercentage": 20,
"down": {"maxScaleDownPercentage": 30
}
},
"tags": [{"tagKey": "Creator",
"tagValue": "John Doe"
}
],
"blockDeviceMappings": [{"deviceName": "/dev/xvda",
"ebs": {"throughput": 125,
"deleteOnTermination": false,
"encrypted": false,
"iops": 1,
"kmsKeyId": "alias/aws/ebs",
"snapshotId": "snap-abcdefghi111110",
"volumeType": "gp2",
"volumeSize": 0,
"dynamicVolumeSize": {"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
}
}
}
],
"resourceLimits": {"maxInstanceCount": 5,
"minInstanceCount": 2
},
"strategy": {"spotPercentage": 70
},
"associatePublicIpAddress": false,
"restrictScaleDown": false,
"scheduling": {"tasks": [{"isEnabled": true,
"cronExpression": "0 1 * * *",
"taskType": "manualHeadroomUpdate",
"config": {"headrooms": [{"cpuPerUnit": 1024,
"memoryPerUnit": 512,
"numOfUnits": 2,
"gpuPerUnit": 1
}
]
}
}
],
"shutdownHours": {"timeWindows": ["Sat:08:00-Sun:08:00"
],
"isEnabled": true
}
},
"instanceMetadataOptions": {"httpTokens": "optional",
"httpPutResponseHopLimit": 12
}
}
],
"count": 1,
"kind": "spotinst:ocean:aws:k8s:launchSpec"
}
}

Import ASG To Ocean Virtual Node Group

Returns an Ocean Virtual Node Group (VNG) configuration in a given AWS autoscaling group (ASG). The returned value ("Imported VNG") can then be used as input to the Create Virtual Node Group API in order to create an actual VNG in your Ocean cluster.

Authorizations:

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
autoScalingGroupName required	string Example: autoScalingGroupName=myAutoScalingGroup The ASG name.
oceanId required	string Example: oceanId=o-12345abc Identifier of the Ocean cluster.

Request Body schema: application/json

object

The object specifying the configuration of the VNG.

	Array of objects[ items ] An array of labels to add to the VNG nodes. Only custom user labels are allowed, and not Kubernetes built-in labels or Spot internal labels.
name	string Set launch specification name.
	Array of objects[ items ] Add taints to Launch Spec.

Responses

Request samples

Payload

Content type

application/json

{"launchSpec": {"name": "specialty.nodes.spotk8s.com",
"labels": [{"key": "env",
"value": "test"
}
],
"taints": [{"key": "taintKey",
"value": "taintValue",
"effect": "NoSchedule"
}
]
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/aws/k8s/launchSpec/autoScalingGroup/import",
"method": "POST",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"oceanId": "o-500a5d5a",
"name": "TestTeam1",
"imageId": "ami-0ce21b51cb55a48b8",
"securityGroupIds": [["sg-03ccf232a2bf0f4ea"
]
],
"tags": {"tagKey": "AmazonECSManaged",
"tagValue": ""
},
"instanceMetadataOptions": {"httpTokens": "optional",
"httpPutResponseHopLimit": 12
}
}
],
"count": 1,
"kind": "spotinst:ocean:aws:k8s:launchSpec"
}
}

Import EKS Cluster Node Group To Ocean Virtual Node Group

Returns an Ocean Virtual Node Group (VNG) configuration based on a given AWS EKS Cluster Node Group. The returned value ("Imported VNG") can then be used as input to the Create Virtual Node Group API in order to create an actual VNG in your Ocean cluster.
Notes:
- Make sure to have the necessary permissions in your Spot policy: eks:ListNodegroups, eks:DescribeNodegroup. Click here for the full Spot policy.
- Exactly one of region or oceanId must be supplied as query parameters.

Authorizations:

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
eksClusterName required	string Example: eksClusterName=MyEksCluster Cluster name of the EKS cluster.
eksNodeGroupName required	string Example: eksNodeGroupName=MyEksClusterNodeGroup Node group name to import.
oceanId	string Example: oceanId=o-12345abc Identifier of the Ocean cluster.
region	string Example: region=us-east-1 Region name of the EKS cluster's node group.

Request Body schema: application/json

object

The object specifying the configuration of the VNG.

	Array of objects[ items ] An array of labels to add to the VNG nodes. Only custom user labels are allowed, and not Kubernetes built-in labels or Spot internal labels.
name	string Set launch specification name.

Responses

Request samples

Payload

Content type

application/json

{"launchSpec": {"name": "specialty.nodes.spotk8s.com",
"labels": [{"key": "env",
"value": "test"
}
]
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/aws/k8s/launchSpec/eksNodeGroup/import",
"method": "POST",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"oceanId": "o-500a5d5a",
"name": "TestTeam1",
"imageId": "ami-0ce21b51cb55a48b8",
"securityGroupIds": ["sg-03ccf232a2bf0f4ea"
],
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"instanceMetadataOptions": {"httpTokens": "optional",
"httpPutResponseHopLimit": 12
}
}
],
"count": 1,
"kind": "spotinst:ocean:aws:k8s:launchSpec"
}
}

Launch Nodes in VNG

Launch nodes in Virtual Node Group.

Authorizations:

path Parameters

oceanLaunchSpecId

required

string

Ocean cluster launch specification identifier.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

object (Ocean AWS Virtual Node Group Launch Request)

Object specifying the details for the launch request.

amount

required

integer

The number of nodes to launch.

Responses

Request samples

Payload

Content type

application/json

{"launchRequest": {"amount": 5
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/aws/k8s/launchSpec/ols-12345abc/launchNodes",
"method": "PUT",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"launchSpecId": "ols-f73821bc",
"newInstances": [{"instanceId": "i-08d53d2a1dcede08f",
"availabilityZone": "us-west-2b",
"instanceType": "c3.xlarge",
"lifeCycle": "spot"
}
]
}
],
"count": 1,
"kind": "spotinst:ocean:aws:k8s:launchSpec:launchNodes"
}
}

Create Extended Resource Definition

Creates an Ocean extended resource definition entity.

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

required

object (Ocean Extended Resource Definition)

The Ocean extended resource definition.

mapping required	object (AWS mapping) A mapping between AWS instanceType or `*` as default and its value for the given extended resource.
name required	string The extended resource name as should be requested by your pods and registered to the nodes. Cannot be updated. The name should be a valid Kubernetes extended resource name.

Responses

Request samples

Payload

Content type

application/json

{"extendedResourceDefinition": {"name": "example.com/name",
"mapping": {"c3.large": "2Ki",
"c3.xlarge": "4Ki",
"c3.2xlarge": "8Mi"
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/k8s/extendedResourceDefinition",
"method": "POST",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "erd-123abc",
"name": "example.com/name",
"mapping": {"c3.large": "2Ki",
"c3.xlarge": "4Ki",
"c3.2xlarge": "8Mi"
},
"createdAt": "2021-03-17T08:13:08.000Z",
"updatedAt": "2021-03-17T15:06:13.000Z"
}
],
"count": 1,
"kind": "spotinst:ocean:k8s:extendedResourceDefinition"
}
}

List Extended Resource Definitions

List the configurations for all Ocean extended resource definitions in the specified account.

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/k8s/extendedResourceDefinition",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "erd-123abc",
"name": "example.com/name",
"mapping": {"c3.large": "2Ki",
"c3.xlarge": "4Ki",
"c3.2xlarge": "8Mi"
},
"createdAt": "2021-03-17T08:13:08.000Z",
"updatedAt": "2021-03-17T15:06:13.000Z"
}
],
"count": 1,
"kind": "spotinst:ocean:k8s:extendedResourceDefinition"
}
}

Get Extended Resource Definition

Get the configurations for a specified Ocean extended resource definition.

Authorizations:

path Parameters

oceanExtendedResourceDefinitionId

required

string

Example: erd-12345abc

Identifier of the Ocean extended resource definition.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/k8s/extendedResourceDefinition/erd-12345abc",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "erd-123abc",
"name": "example.com/name",
"mapping": {"c3.large": "2Ki",
"c3.xlarge": "4Ki",
"c3.2xlarge": "8Mi"
},
"createdAt": "2021-03-17T08:13:08.000Z",
"updatedAt": "2021-03-17T15:06:13.000Z"
}
],
"count": 1,
"kind": "spotinst:ocean:k8s:extendedResourceDefinition"
}
}

Update Extended Resource Definition

Only the mapping parameter is updatable for extended resource definition.

Authorizations:

path Parameters

oceanExtendedResourceDefinitionId

required

string

Example: erd-12345abc

Identifier of the Ocean extended resource definition.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

required

object (Ocean Extended Resource Definition)

The Ocean extended resource definition.

mapping required	object (AWS mapping) A mapping between AWS instanceType or `*` as default and its value for the given extended resource.
name required	string The extended resource name as should be requested by your pods and registered to the nodes. Cannot be updated. The name should be a valid Kubernetes extended resource name.

Responses

Request samples

Payload

Content type

application/json

{"extendedResourceDefinition": {"name": "example.com/name",
"mapping": {"c3.large": "2Ki",
"c3.xlarge": "4Ki",
"c3.2xlarge": "8Mi"
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/k8s/extendedResourceDefinition/erd-12345abc",
"method": "PUT",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "erd-123abc",
"name": "example.com/name",
"mapping": {"c3.large": "2Ki",
"c3.xlarge": "4Ki",
"c3.2xlarge": "8Mi"
},
"createdAt": "2021-03-17T08:13:08.000Z",
"updatedAt": "2021-03-17T15:06:13.000Z"
}
],
"count": 1,
"kind": "spotinst:ocean:k8s:extendedResourceDefinition"
}
}

Delete Extended Resource Definition

Delete a specified Ocean extended resource definition.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-12345abc

Identifier of the Ocean cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/k8s/extendedResourceDefinition/erd-12345abc",
"method": "DELETE",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Ocean ECS

Ocean - Serverless containers for Amazon Elastic Container Service (ECS)

List Clusters

Get the configurations for all Ocean clusters in the specified account.

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"cluster": {"id": "o-12345abc",
"name": "Ocean::my-elastigroup-name",
"clusterName": "my-ECS-cluster-name",
"autoScaler": {"isEnabled": true,
"cooldown": 300,
"attributes": {"key": "the_key",
"value": "the_value"
},
"resourceLimits": {"maxMemoryGib": 1,
"maxVcpu": 1
},
"down": {"evaluationPeriods": 4,
"maxScaleDownPercentage": 20
},
"headroom": {"cpuPerUnit": 2048,
"memoryPerUnit": 3,
"numOfUnits": 2
},
"isAutoConfig": false,
"autoHeadroomPercentage": 20,
"shouldScaleDownNonServiceTasks": true,
"enableAutomaticAndManualHeadroom": false
},
"region": "us-east-1",
"capacity": {"minimum": 1,
"maximum": 10,
"target": 5,
"unit": "instance"
},
"strategy": {"utilizeReservedInstances": true,
"fallbackToOd": true,
"spotPercentage": 100,
"drainingTimeout": 200,
"utilizeCommitments": false
},
"compute": {"subnetIds": ["subnet-1234abcd"
],
"instanceTypes": {"whitelist": ["c4.xlarge",
"c4.2xlarge",
"c4.4xlarge",
"c4.8xlarge"
],
"blacklist": ["r5.large",
"r5.xlarge"
]
},
"launchSpecification": {"associatePublicIpAddress": false,
"associateIpv6Address": false,
"imageId": "ami-123456789abcdefgh",
"securityGroupIds": ["sg-abcdefgh123456789"
],
"iamInstanceProfile": {"arn": "my-arn"
},
"blockDeviceMappings": [{"deviceName": "/dev/xvda",
"ebs": {"throughput": 125,
"deleteOnTermination": false,
"encrypted": false,
"iops": 1,
"kmsKeyId": "alias/aws/ebs",
"snapshotId": "snap-abcdefghi111110",
"volumeType": "gp2",
"volumeSize": 0,
"dynamicVolumeSize": {"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
}
}
}
],
"instanceMetadataOptions": {"httpTokens": "optional",
"httpPutResponseHopLimit": 12,
"httpEndpoint": "disabled"
},
"userData": "Q29udGVudC1UeXBlOiBtdWx0aXBhcnQvbWl4ZWQ7IGJvdW5kYXJ5PSI9PT09PT09PT09PT09PT01MTg5MDY1Mzc3MjIyODk4NDA3PT0iCk1JTUUtVmVyc2lvbjogMS4wCgotLT09PT09PT09PT09PT09PTUxODkwNjUzNzcyMjI4OTg0MDc9PQp",
"useAsTemplateOnly": false
},
"optimizeImage": {"shouldOptimizeEcsAmi": "true",
"performAt": "never",
"timeWindows": ["['Sun:02:00-Sun:12:00', 'Wed:01:01-Fri:02:03']"
]
}
},
"scheduling": {"tasks": [{"isEnabled": false,
"cronExpression": "string",
"taskType": "clusterRoll",
"parameters": {"clusterRoll": {"batchSizePercentage": 20,
"comment": "This is why I deployed my cluster.",
"batchMinHealthyPercentage": 100
}
}
}
],
"shutdownHours": {"timeWindows": ["Sat:08:00-Sun:08:00"
],
"isEnabled": true
}
},
"logging": {"export": {"s3": {"id": "di-123"
}
}
},
"createdAt": "2019-06-03T08:13:08.000Z",
"updatedAt": "2019-06-10T15:06:13.000Z"
}
}
],
"count": 1,
"kind": "spotinst:ocean:aws:ecs"
}
}

Create Cluster

Create a new Ocean ECS cluster in the specified account.

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

required

object (ECS Ocean)

	object (Ocean Autoscaler) The Ocean ECS Autoscaler.
	object (Capacity Units) Capacity specifications for the Ocean cluster.
clusterName	string ECS cluster name.
	object (Ocean Compute)
	object (Logging configuration)
name	string Add a name for the Ocean cluster.
region	string Select the region for the Ocean cluster to run in.
	object (Ocean Scheduling) An object used to define times for a task such as a shutdown to be activated.
	object (Ocean Strategy) Strategy Configuration of the Ocean cluster.

Responses

Request samples

Payload

Content type

application/json

{"cluster": {"name": "Ocean::my-elastigroup-name",
"clusterName": "my-ECS-cluster-name",
"autoScaler": {"isEnabled": true,
"cooldown": 300,
"attributes": {"key": "the_key",
"value": "the_value"
},
"resourceLimits": {"maxMemoryGib": 1,
"maxVcpu": 1
},
"down": {"evaluationPeriods": 4,
"maxScaleDownPercentage": 20
},
"headroom": {"cpuPerUnit": 2048,
"memoryPerUnit": 3,
"numOfUnits": 2
},
"isAutoConfig": false,
"autoHeadroomPercentage": 20,
"shouldScaleDownNonServiceTasks": true,
"enableAutomaticAndManualHeadroom": false
},
"region": "us-east-1",
"capacity": {"minimum": 1,
"maximum": 10,
"target": 5,
"unit": "instance"
},
"strategy": {"utilizeReservedInstances": true,
"fallbackToOd": true,
"spotPercentage": 100,
"drainingTimeout": 200,
"utilizeCommitments": false
},
"compute": {"subnetIds": ["subnet-1234abcd"
],
"instanceTypes": {"whitelist": ["c4.xlarge",
"c4.2xlarge",
"c4.4xlarge",
"c4.8xlarge"
],
"blacklist": ["r5.large",
"r5.xlarge"
]
},
"launchSpecification": {"associatePublicIpAddress": false,
"associateIpv6Address": false,
"imageId": "ami-123456789abcdefgh",
"securityGroupIds": ["sg-abcdefgh123456789"
],
"iamInstanceProfile": {"arn": "my-arn"
},
"blockDeviceMappings": [{"deviceName": "/dev/xvda",
"ebs": {"throughput": 125,
"deleteOnTermination": false,
"encrypted": false,
"iops": 1,
"kmsKeyId": "alias/aws/ebs",
"snapshotId": "snap-abcdefghi111110",
"volumeType": "gp2",
"volumeSize": 0,
"dynamicVolumeSize": {"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
}
}
}
],
"instanceMetadataOptions": {"httpTokens": "optional",
"httpPutResponseHopLimit": 12,
"httpEndpoint": "disabled"
},
"userData": "Q29udGVudC1UeXBlOiBtdWx0aXBhcnQvbWl4ZWQ7IGJvdW5kYXJ5PSI9PT09PT09PT09PT09PT01MTg5MDY1Mzc3MjIyODk4NDA3PT0iCk1JTUUtVmVyc2lvbjogMS4wCgotLT09PT09PT09PT09PT09PTUxODkwNjUzNzcyMjI4OTg0MDc9PQp",
"useAsTemplateOnly": false
},
"optimizeImage": {"shouldOptimizeEcsAmi": "true",
"performAt": "never",
"timeWindows": ["['Sun:02:00-Sun:12:00', 'Wed:01:01-Fri:02:03']"
]
}
},
"scheduling": {"tasks": [{"isEnabled": false,
"cronExpression": "string",
"taskType": "clusterRoll",
"parameters": {"clusterRoll": {"batchSizePercentage": 20,
"comment": "This is why I deployed my cluster.",
"batchMinHealthyPercentage": 100
}
}
}
],
"shutdownHours": {"timeWindows": ["Sat:08:00-Sun:08:00"
],
"isEnabled": true
}
},
"logging": {"export": {"s3": {"id": "di-123"
}
}
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"cluster": {"id": "o-12345abc",
"name": "Ocean::my-elastigroup-name",
"clusterName": "my-ECS-cluster-name",
"autoScaler": {"isEnabled": true,
"cooldown": 300,
"attributes": {"key": "the_key",
"value": "the_value"
},
"resourceLimits": {"maxMemoryGib": 1,
"maxVcpu": 1
},
"down": {"evaluationPeriods": 4,
"maxScaleDownPercentage": 20
},
"headroom": {"cpuPerUnit": 2048,
"memoryPerUnit": 3,
"numOfUnits": 2
},
"isAutoConfig": false,
"autoHeadroomPercentage": 20,
"shouldScaleDownNonServiceTasks": true,
"enableAutomaticAndManualHeadroom": false
},
"region": "us-east-1",
"capacity": {"minimum": 1,
"maximum": 10,
"target": 5,
"unit": "instance"
},
"strategy": {"utilizeReservedInstances": true,
"fallbackToOd": true,
"spotPercentage": 100,
"drainingTimeout": 200,
"utilizeCommitments": false
},
"compute": {"subnetIds": ["subnet-1234abcd"
],
"instanceTypes": {"whitelist": ["c4.xlarge",
"c4.2xlarge",
"c4.4xlarge",
"c4.8xlarge"
],
"blacklist": ["r5.large",
"r5.xlarge"
]
},
"launchSpecification": {"associatePublicIpAddress": false,
"associateIpv6Address": false,
"imageId": "ami-123456789abcdefgh",
"securityGroupIds": ["sg-abcdefgh123456789"
],
"iamInstanceProfile": {"arn": "my-arn"
},
"blockDeviceMappings": [{"deviceName": "/dev/xvda",
"ebs": {"throughput": 125,
"deleteOnTermination": false,
"encrypted": false,
"iops": 1,
"kmsKeyId": "alias/aws/ebs",
"snapshotId": "snap-abcdefghi111110",
"volumeType": "gp2",
"volumeSize": 0,
"dynamicVolumeSize": {"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
}
}
}
],
"instanceMetadataOptions": {"httpTokens": "optional",
"httpPutResponseHopLimit": 12,
"httpEndpoint": "disabled"
},
"userData": "Q29udGVudC1UeXBlOiBtdWx0aXBhcnQvbWl4ZWQ7IGJvdW5kYXJ5PSI9PT09PT09PT09PT09PT01MTg5MDY1Mzc3MjIyODk4NDA3PT0iCk1JTUUtVmVyc2lvbjogMS4wCgotLT09PT09PT09PT09PT09PTUxODkwNjUzNzcyMjI4OTg0MDc9PQp",
"useAsTemplateOnly": false
},
"optimizeImage": {"shouldOptimizeEcsAmi": "true",
"performAt": "never",
"timeWindows": ["['Sun:02:00-Sun:12:00', 'Wed:01:01-Fri:02:03']"
]
}
},
"scheduling": {"tasks": [{"isEnabled": false,
"cronExpression": "string",
"taskType": "clusterRoll",
"parameters": {"clusterRoll": {"batchSizePercentage": 20,
"comment": "This is why I deployed my cluster.",
"batchMinHealthyPercentage": 100
}
}
}
],
"shutdownHours": {"timeWindows": ["Sat:08:00-Sun:08:00"
],
"isEnabled": true
}
},
"logging": {"export": {"s3": {"id": "di-123"
}
}
},
"createdAt": "2019-06-03T08:13:08.000Z",
"updatedAt": "2019-06-10T15:06:13.000Z"
}
}
],
"count": 1,
"kind": "spotinst:ocean:aws:ecs"
}
}

Get Cluster

Get the configurations for a specified Ocean cluster.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-12345abc

Identifier of the Ocean cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"cluster": {"id": "o-12345abc",
"name": "Ocean::my-elastigroup-name",
"clusterName": "my-ECS-cluster-name",
"autoScaler": {"isEnabled": true,
"cooldown": 300,
"attributes": {"key": "the_key",
"value": "the_value"
},
"resourceLimits": {"maxMemoryGib": 1,
"maxVcpu": 1
},
"down": {"evaluationPeriods": 4,
"maxScaleDownPercentage": 20
},
"headroom": {"cpuPerUnit": 2048,
"memoryPerUnit": 3,
"numOfUnits": 2
},
"isAutoConfig": false,
"autoHeadroomPercentage": 20,
"shouldScaleDownNonServiceTasks": true,
"enableAutomaticAndManualHeadroom": false
},
"region": "us-east-1",
"capacity": {"minimum": 1,
"maximum": 10,
"target": 5,
"unit": "instance"
},
"strategy": {"utilizeReservedInstances": true,
"fallbackToOd": true,
"spotPercentage": 100,
"drainingTimeout": 200,
"utilizeCommitments": false
},
"compute": {"subnetIds": ["subnet-1234abcd"
],
"instanceTypes": {"whitelist": ["c4.xlarge",
"c4.2xlarge",
"c4.4xlarge",
"c4.8xlarge"
],
"blacklist": ["r5.large",
"r5.xlarge"
]
},
"launchSpecification": {"associatePublicIpAddress": false,
"associateIpv6Address": false,
"imageId": "ami-123456789abcdefgh",
"securityGroupIds": ["sg-abcdefgh123456789"
],
"iamInstanceProfile": {"arn": "my-arn"
},
"blockDeviceMappings": [{"deviceName": "/dev/xvda",
"ebs": {"throughput": 125,
"deleteOnTermination": false,
"encrypted": false,
"iops": 1,
"kmsKeyId": "alias/aws/ebs",
"snapshotId": "snap-abcdefghi111110",
"volumeType": "gp2",
"volumeSize": 0,
"dynamicVolumeSize": {"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
}
}
}
],
"instanceMetadataOptions": {"httpTokens": "optional",
"httpPutResponseHopLimit": 12,
"httpEndpoint": "disabled"
},
"userData": "Q29udGVudC1UeXBlOiBtdWx0aXBhcnQvbWl4ZWQ7IGJvdW5kYXJ5PSI9PT09PT09PT09PT09PT01MTg5MDY1Mzc3MjIyODk4NDA3PT0iCk1JTUUtVmVyc2lvbjogMS4wCgotLT09PT09PT09PT09PT09PTUxODkwNjUzNzcyMjI4OTg0MDc9PQp",
"useAsTemplateOnly": false
},
"optimizeImage": {"shouldOptimizeEcsAmi": "true",
"performAt": "never",
"timeWindows": ["['Sun:02:00-Sun:12:00', 'Wed:01:01-Fri:02:03']"
]
}
},
"scheduling": {"tasks": [{"isEnabled": false,
"cronExpression": "string",
"taskType": "clusterRoll",
"parameters": {"clusterRoll": {"batchSizePercentage": 20,
"comment": "This is why I deployed my cluster.",
"batchMinHealthyPercentage": 100
}
}
}
],
"shutdownHours": {"timeWindows": ["Sat:08:00-Sun:08:00"
],
"isEnabled": true
}
},
"logging": {"export": {"s3": {"id": "di-123"
}
}
},
"createdAt": "2019-06-03T08:13:08.000Z",
"updatedAt": "2019-06-10T15:06:13.000Z"
}
}
],
"count": 1,
"kind": "spotinst:ocean:aws:ecs"
}
}

Update Cluster

All Ocean parameters are updatable, excluding Region and ID. This API supports partial updates, so specific fields can be updated separately.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-12345abc

Identifier of the Ocean cluster.

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
autoApplyTags	boolean Default: false Example: autoApplyTags=true Optionally update resource tags on the fly without performing a roll.

Request Body schema: application/json

required

object (ECS Ocean)

	object (Ocean Autoscaler) The Ocean ECS Autoscaler.
	object (Capacity Units) Capacity specifications for the Ocean cluster.
clusterName	string ECS cluster name.
	object (Ocean Compute)
	object (Logging configuration)
name	string Add a name for the Ocean cluster.
region	string Select the region for the Ocean cluster to run in.
	object (Ocean Scheduling) An object used to define times for a task such as a shutdown to be activated.
	object (Ocean Strategy) Strategy Configuration of the Ocean cluster.

Responses

Request samples

Payload

Content type

application/json

{"cluster": {"name": "Ocean::my-elastigroup-name",
"clusterName": "my-ECS-cluster-name",
"autoScaler": {"isEnabled": true,
"cooldown": 300,
"attributes": {"key": "the_key",
"value": "the_value"
},
"resourceLimits": {"maxMemoryGib": 1,
"maxVcpu": 1
},
"down": {"evaluationPeriods": 4,
"maxScaleDownPercentage": 20
},
"headroom": {"cpuPerUnit": 2048,
"memoryPerUnit": 3,
"numOfUnits": 2
},
"isAutoConfig": false,
"autoHeadroomPercentage": 20,
"shouldScaleDownNonServiceTasks": true,
"enableAutomaticAndManualHeadroom": false
},
"region": "us-east-1",
"capacity": {"minimum": 1,
"maximum": 10,
"target": 5,
"unit": "instance"
},
"strategy": {"utilizeReservedInstances": true,
"fallbackToOd": true,
"spotPercentage": 100,
"drainingTimeout": 200,
"utilizeCommitments": false
},
"compute": {"subnetIds": ["subnet-1234abcd"
],
"instanceTypes": {"whitelist": ["c4.xlarge",
"c4.2xlarge",
"c4.4xlarge",
"c4.8xlarge"
],
"blacklist": ["r5.large",
"r5.xlarge"
]
},
"launchSpecification": {"associatePublicIpAddress": false,
"associateIpv6Address": false,
"imageId": "ami-123456789abcdefgh",
"securityGroupIds": ["sg-abcdefgh123456789"
],
"iamInstanceProfile": {"arn": "my-arn"
},
"blockDeviceMappings": [{"deviceName": "/dev/xvda",
"ebs": {"throughput": 125,
"deleteOnTermination": false,
"encrypted": false,
"iops": 1,
"kmsKeyId": "alias/aws/ebs",
"snapshotId": "snap-abcdefghi111110",
"volumeType": "gp2",
"volumeSize": 0,
"dynamicVolumeSize": {"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
}
}
}
],
"instanceMetadataOptions": {"httpTokens": "optional",
"httpPutResponseHopLimit": 12,
"httpEndpoint": "disabled"
},
"userData": "Q29udGVudC1UeXBlOiBtdWx0aXBhcnQvbWl4ZWQ7IGJvdW5kYXJ5PSI9PT09PT09PT09PT09PT01MTg5MDY1Mzc3MjIyODk4NDA3PT0iCk1JTUUtVmVyc2lvbjogMS4wCgotLT09PT09PT09PT09PT09PTUxODkwNjUzNzcyMjI4OTg0MDc9PQp",
"useAsTemplateOnly": false
},
"optimizeImage": {"shouldOptimizeEcsAmi": "true",
"performAt": "never",
"timeWindows": ["['Sun:02:00-Sun:12:00', 'Wed:01:01-Fri:02:03']"
]
}
},
"scheduling": {"tasks": [{"isEnabled": false,
"cronExpression": "string",
"taskType": "clusterRoll",
"parameters": {"clusterRoll": {"batchSizePercentage": 20,
"comment": "This is why I deployed my cluster.",
"batchMinHealthyPercentage": 100
}
}
}
],
"shutdownHours": {"timeWindows": ["Sat:08:00-Sun:08:00"
],
"isEnabled": true
}
},
"logging": {"export": {"s3": {"id": "di-123"
}
}
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"cluster": {"id": "o-12345abc",
"name": "Ocean::my-elastigroup-name",
"clusterName": "my-ECS-cluster-name",
"autoScaler": {"isEnabled": true,
"cooldown": 300,
"attributes": {"key": "the_key",
"value": "the_value"
},
"resourceLimits": {"maxMemoryGib": 1,
"maxVcpu": 1
},
"down": {"evaluationPeriods": 4,
"maxScaleDownPercentage": 20
},
"headroom": {"cpuPerUnit": 2048,
"memoryPerUnit": 3,
"numOfUnits": 2
},
"isAutoConfig": false,
"autoHeadroomPercentage": 20,
"shouldScaleDownNonServiceTasks": true,
"enableAutomaticAndManualHeadroom": false
},
"region": "us-east-1",
"capacity": {"minimum": 1,
"maximum": 10,
"target": 5,
"unit": "instance"
},
"strategy": {"utilizeReservedInstances": true,
"fallbackToOd": true,
"spotPercentage": 100,
"drainingTimeout": 200,
"utilizeCommitments": false
},
"compute": {"subnetIds": ["subnet-1234abcd"
],
"instanceTypes": {"whitelist": ["c4.xlarge",
"c4.2xlarge",
"c4.4xlarge",
"c4.8xlarge"
],
"blacklist": ["r5.large",
"r5.xlarge"
]
},
"launchSpecification": {"associatePublicIpAddress": false,
"associateIpv6Address": false,
"imageId": "ami-123456789abcdefgh",
"securityGroupIds": ["sg-abcdefgh123456789"
],
"iamInstanceProfile": {"arn": "my-arn"
},
"blockDeviceMappings": [{"deviceName": "/dev/xvda",
"ebs": {"throughput": 125,
"deleteOnTermination": false,
"encrypted": false,
"iops": 1,
"kmsKeyId": "alias/aws/ebs",
"snapshotId": "snap-abcdefghi111110",
"volumeType": "gp2",
"volumeSize": 0,
"dynamicVolumeSize": {"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
}
}
}
],
"instanceMetadataOptions": {"httpTokens": "optional",
"httpPutResponseHopLimit": 12,
"httpEndpoint": "disabled"
},
"userData": "Q29udGVudC1UeXBlOiBtdWx0aXBhcnQvbWl4ZWQ7IGJvdW5kYXJ5PSI9PT09PT09PT09PT09PT01MTg5MDY1Mzc3MjIyODk4NDA3PT0iCk1JTUUtVmVyc2lvbjogMS4wCgotLT09PT09PT09PT09PT09PTUxODkwNjUzNzcyMjI4OTg0MDc9PQp",
"useAsTemplateOnly": false
},
"optimizeImage": {"shouldOptimizeEcsAmi": "true",
"performAt": "never",
"timeWindows": ["['Sun:02:00-Sun:12:00', 'Wed:01:01-Fri:02:03']"
]
}
},
"scheduling": {"tasks": [{"isEnabled": false,
"cronExpression": "string",
"taskType": "clusterRoll",
"parameters": {"clusterRoll": {"batchSizePercentage": 20,
"comment": "This is why I deployed my cluster.",
"batchMinHealthyPercentage": 100
}
}
}
],
"shutdownHours": {"timeWindows": ["Sat:08:00-Sun:08:00"
],
"isEnabled": true
}
},
"logging": {"export": {"s3": {"id": "di-123"
}
}
},
"createdAt": "2019-06-03T08:13:08.000Z",
"updatedAt": "2019-06-10T15:06:13.000Z"
}
}
],
"count": 1,
"kind": "spotinst:ocean:aws:ecs"
}
}

Delete Cluster

Delete a specified Ocean cluster.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-12345abc

Identifier of the Ocean cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Import Cluster

Create Ocean cluster object from an existing ECS cluster with at least one container instance to be used as input for create cluster.
This route will not register the ECS cluster to Ocean.

Authorizations:

path Parameters

EcsClusterName

required

string

Example: ecsName

ECS Cluster name

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

name	string The name for the new Ocean cluster object. If the name is not provided, the default will be Ocean_{EcsClusterName}
region required	string The region that the ECS cluster is running at.

Responses

Request samples

Payload

Content type

application/json

{"region": "us-east-1",
"name": "oceanName"
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/aws/ecs/cluster/my-ECS-cluster-name/import",
"method": "POST",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"cluster": {"name": "my-Ocean-ECS-cluster",
"clusterName": "my-ECS-cluster-name",
"region": "us-east-1",
"compute": {"subnetIds": ["subnet-1234abcd"
],
"launchSpecification": {"imageId": "ami-123456789abcdefgh",
"securityGroupIds": ["sg-abcdefgh123456789"
],
"keyPair": "dev-keypair",
"userData": "userData",
"iamInstanceProfile": {"arn": "my-arn"
},
"tags": {"tagKey": "env",
"tagValue": "dev"
},
"instanceMetadataOptions": {"httpTokens": "optional",
"httpPutResponseHopLimit": 12,
"httpEndpoint": "disabled"
}
}
}
}
}
],
"count": 1,
"kind": "spotinst:ocean:aws:ecs"
}
}

Fetch Elastilog

Get the log of an Ocean Cluster.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-abcd1234

Identifier of the Ocean cluster.

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
fromDate required	string Beginning date value using either the date format "yyyy-mm-dd; 2016-11-20" or ms "1494751821472".
LIMIT	integer <= 1000 Default: 500 Example: LIMIT=200 Maximum number of lines to extract in a response.
resourceId	string Example: resourceId=i-12345678 Filter extracted log entries for a specific resource identifier. Default: Null
SEVERITY	string Default: "ALL" Enum: "ALL" "INFO" "DEBUG" "WARN" Example: SEVERITY=INFO Severity of log entries to extract.
toDate required	string End date value using either the date format "yyyy-mm-dd; 2016-11-20" or ms "1494751821472".

Responses

Response samples

Content type

application/json

{"request": {"id": "3213f42e-455e-4801-a185-cd3eb65fac5f",
"url": "/ocean/aws/ecs/cluster/o-e0a2bd7c/log?fromDate=2020-10-06&toDate=2020-10-08&severity=ALL&limit=500",
"method": "GET",
"timestamp": "2020-10-05T16:20:38.579Z"
},
"response": {"status": {"code": "200",
"message": "OK"
},
"kind": "spotinst:ocean:cluster:log",
"items": [{"message": "Instances Terminated - ECS Autoscaler ,Terminated 1, List of instances: [i-0914721d46ebbabb2]",
"severity": "INFO",
"createdAt": "2020-10-07T09:51:12.000Z"
},
{"message": "Instances: [i-0914721d46ebbabb2] have been detached. Reason: Auto scale",
"severity": "INFO",
"createdAt": "2020-10-07T09:51:11.000Z"
}
],
"count": "2"
}
}

Get Right Sizing Recommendations

Get right-sizing recommendations for an Ocean cluster.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-12345abc

Identifier of the Ocean cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"suggestedMemory": 2,
"requestedMemory": 100,
"serviceName": "sg-test",
"suggestedCpu": 0,
"requestedCpu": 128
}
],
"count": 1,
"kind": "spotinst:ocean:aws:ecs:cluster:rightSizing:resourceSuggestion"
}
}

Upgrade Elastigroup to Ocean

Upgrade an Elastigroup with ECS integration into Ocean for ECS cluster.

Authorizations:

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
groupId required	string Example: groupId=sig-1234abcd The identifier of the Elastigroup to upgrade.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"cluster": {"id": "o-12345abc",
"name": "Ocean::my-elastigroup-name",
"clusterName": "my-ECS-cluster-name",
"autoScaler": {"isEnabled": true,
"cooldown": 300,
"attributes": {"key": "the_key",
"value": "the_value"
},
"resourceLimits": {"maxMemoryGib": 1,
"maxVcpu": 1
},
"down": {"evaluationPeriods": 4,
"maxScaleDownPercentage": 20
},
"headroom": {"cpuPerUnit": 2048,
"memoryPerUnit": 3,
"numOfUnits": 2
},
"isAutoConfig": false,
"autoHeadroomPercentage": 20,
"shouldScaleDownNonServiceTasks": true,
"enableAutomaticAndManualHeadroom": false
},
"region": "us-east-1",
"capacity": {"minimum": 1,
"maximum": 10,
"target": 5,
"unit": "instance"
},
"strategy": {"utilizeReservedInstances": true,
"fallbackToOd": true,
"spotPercentage": 100,
"drainingTimeout": 200,
"utilizeCommitments": false
},
"compute": {"subnetIds": ["subnet-1234abcd"
],
"instanceTypes": {"whitelist": ["c4.xlarge",
"c4.2xlarge",
"c4.4xlarge",
"c4.8xlarge"
],
"blacklist": ["r5.large",
"r5.xlarge"
]
},
"launchSpecification": {"associatePublicIpAddress": false,
"associateIpv6Address": false,
"imageId": "ami-123456789abcdefgh",
"securityGroupIds": ["sg-abcdefgh123456789"
],
"iamInstanceProfile": {"arn": "my-arn"
},
"blockDeviceMappings": [{"deviceName": "/dev/xvda",
"ebs": {"throughput": 125,
"deleteOnTermination": false,
"encrypted": false,
"iops": 1,
"kmsKeyId": "alias/aws/ebs",
"snapshotId": "snap-abcdefghi111110",
"volumeType": "gp2",
"volumeSize": 0,
"dynamicVolumeSize": {"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
}
}
}
],
"instanceMetadataOptions": {"httpTokens": "optional",
"httpPutResponseHopLimit": 12,
"httpEndpoint": "disabled"
},
"userData": "Q29udGVudC1UeXBlOiBtdWx0aXBhcnQvbWl4ZWQ7IGJvdW5kYXJ5PSI9PT09PT09PT09PT09PT01MTg5MDY1Mzc3MjIyODk4NDA3PT0iCk1JTUUtVmVyc2lvbjogMS4wCgotLT09PT09PT09PT09PT09PTUxODkwNjUzNzcyMjI4OTg0MDc9PQp",
"useAsTemplateOnly": false
},
"optimizeImage": {"shouldOptimizeEcsAmi": "true",
"performAt": "never",
"timeWindows": ["['Sun:02:00-Sun:12:00', 'Wed:01:01-Fri:02:03']"
]
}
},
"scheduling": {"tasks": [{"isEnabled": false,
"cronExpression": "string",
"taskType": "clusterRoll",
"parameters": {"clusterRoll": {"batchSizePercentage": 20,
"comment": "This is why I deployed my cluster.",
"batchMinHealthyPercentage": 100
}
}
}
],
"shutdownHours": {"timeWindows": ["Sat:08:00-Sun:08:00"
],
"isEnabled": true
}
},
"logging": {"export": {"s3": {"id": "di-123"
}
}
},
"createdAt": "2019-06-03T08:13:08.000Z",
"updatedAt": "2019-06-10T15:06:13.000Z"
}
}
],
"count": 1,
"kind": "spotinst:ocean:aws:ecs"
}
}

Initiate Roll

Roll an entire Ocean cluster or roll subsets of the cluster by specifying launchSpecIds or instanceIds. Performing this request will start the roll immediately according to defined batches. Note that the first response for a successful request will indicate the start of a roll. In order to check the status of a roll, you can use the GET Roll API using the roll identifier.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-12345abc

Identifier of the Ocean cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

One of

object

batchMinHealthyPercentage	integer Default: 50 Indicates the threshold of minimum healthy instances in single batch. If the amount of healthy instances in single batch is under the threshold, the cluster roll will fail. If exists, the parameter value will be in range of 1-100. In case of null as value, the default value in the backend will be 50%. Value of param should represent the number in percentage (%) of the batch.
batchSizePercentage	integer Value (in percent) to set size of batch in roll. Valid values are 0-100.
comment	string Add a brief description for the roll. The comment is limited to 256 chars.

Responses

Request samples

Payload

Content type

application/json

Example

{"roll": {"batchSizePercentage": 20,
"comment": "This is why I rolled my cluster.",
"batchMinHealthyPercentage": 100
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "scr-1234abcd",
"scope": "Cluster",
"currentBatch": 1,
"numOfBatches": 2,
"progress": {"unit": "percentage",
"value": 10,
"detailedStatus": {"oldInstances": [{"instanceId": "i-003a0281a24c01a20",
"status": "REPLACED"
},
{"instanceId": "i-003a0281a24c01a21",
"status": "TO_BE_REPLACED"
},
{"instanceId": "i-003a0281a24c01a22",
"status": "COULD_NOT_BE_REPLACED"
}
]
}
},
"oceanId": "o-abcd1234",
"createdAt": "2019-06-03T08:13:08.000Z",
"updatedAt": "2019-06-10T15:06:13.000Z",
"status": "IN_PROGRESS",
"comment": "This is why I rolled my cluster.",
"batchMinHealthyPercentage": 100,
"instanceIds": ["i-0003a99ffb566f039, i-0567a99ffb566f765"
]
}
],
"count": 1,
"kind": "spotinst:ocean:aws:ecs:cluster:roll"
}
}

List Rolls

List rolls of an Ocean cluster.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-12345abc

Identifier of the Ocean cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "scr-1234abcd",
"scope": "Cluster",
"currentBatch": 1,
"numOfBatches": 2,
"progress": {"unit": "percentage",
"value": 10,
"detailedStatus": {"oldInstances": [{"instanceId": "i-003a0281a24c01a20",
"status": "REPLACED"
},
{"instanceId": "i-003a0281a24c01a21",
"status": "TO_BE_REPLACED"
},
{"instanceId": "i-003a0281a24c01a22",
"status": "COULD_NOT_BE_REPLACED"
}
]
}
},
"oceanId": "o-abcd1234",
"createdAt": "2019-06-03T08:13:08.000Z",
"updatedAt": "2019-06-10T15:06:13.000Z",
"status": "IN_PROGRESS",
"comment": "This is why I rolled my cluster.",
"batchMinHealthyPercentage": 100,
"instanceIds": ["i-0003a99ffb566f039, i-0567a99ffb566f765"
]
}
],
"count": 1,
"kind": "spotinst:ocean:aws:ecs:cluster:roll"
}
}

Update Roll

Update a roll of an Ocean cluster. Performing the request will stop the next batch in a roll.

Authorizations:

path Parameters

oceanClusterId required	string Example: o-12345abc Identifier of the Ocean cluster.
ROLL_ID required	string Example: scr-12345abc Ocean Cluster Roll identifier

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

status

string

Value: "STOPPED"

Sets the status of the roll.

Responses

Request samples

Payload

Content type

application/json

{"status": "STOPPED"
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "scr-1234abcd",
"scope": "Cluster",
"currentBatch": 1,
"numOfBatches": 2,
"progress": {"unit": "percentage",
"value": 10,
"detailedStatus": {"oldInstances": [{"instanceId": "i-003a0281a24c01a20",
"status": "REPLACED"
},
{"instanceId": "i-003a0281a24c01a21",
"status": "TO_BE_REPLACED"
},
{"instanceId": "i-003a0281a24c01a22",
"status": "COULD_NOT_BE_REPLACED"
}
]
}
},
"oceanId": "o-abcd1234",
"createdAt": "2019-06-03T08:13:08.000Z",
"updatedAt": "2019-06-10T15:06:13.000Z",
"status": "IN_PROGRESS",
"comment": "This is why I rolled my cluster.",
"batchMinHealthyPercentage": 100,
"instanceIds": ["i-0003a99ffb566f039, i-0567a99ffb566f765"
]
}
],
"count": 1,
"kind": "spotinst:ocean:aws:ecs:cluster:roll"
}
}

Get Roll

Get status for roll of an Ocean cluster.

Authorizations:

path Parameters

oceanClusterId required	string Example: o-12345abc Identifier of the Ocean cluster.
ROLL_ID required	string Example: scr-12345abc Ocean Cluster Roll identifier

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "scr-1234abcd",
"scope": "Cluster",
"currentBatch": 1,
"numOfBatches": 2,
"progress": {"unit": "percentage",
"value": 10,
"detailedStatus": {"oldInstances": [{"instanceId": "i-003a0281a24c01a20",
"status": "REPLACED"
},
{"instanceId": "i-003a0281a24c01a21",
"status": "TO_BE_REPLACED"
},
{"instanceId": "i-003a0281a24c01a22",
"status": "COULD_NOT_BE_REPLACED"
}
]
}
},
"oceanId": "o-abcd1234",
"createdAt": "2019-06-03T08:13:08.000Z",
"updatedAt": "2019-06-10T15:06:13.000Z",
"status": "IN_PROGRESS",
"comment": "This is why I rolled my cluster.",
"batchMinHealthyPercentage": 100,
"instanceIds": ["i-0003a99ffb566f039, i-0567a99ffb566f765"
]
}
],
"count": 1,
"kind": "spotinst:ocean:aws:ecs:cluster:roll"
}
}

Get Cluster Container Instances

Get container instances data of an Ocean cluster.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-12345abc

Identifier of the Ocean cluster.

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
instanceId	string Example: instanceId=i-123 Get a specific container instance ec2 instance id.
launchSpecId	string Example: launchSpecId=ols-123abc Ocean cluster launch specification identifier.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/aws/ecs/cluster/o-12345abc/containerInstances",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"instanceId": "i-123",
"instanceType": "c3.large",
"availabilityZone": "us-west-2b",
"launchSpecId": "ols-123",
"launchSpecName": "dev-launchSpec",
"lifeCycle": "Spot",
"publicIp": "1.2.3.4",
"workloadRequestedCpuUnit": 1320,
"workloadRequestedMemoryInMiB": 500,
"workloadRequestedGpu": 1,
"headroomRequestedCpuUnit": 1320,
"headroomRequestedMemoryInMiB": 512,
"headroomRequestedGpu": 1,
"registeredCpuUnit": 2000,
"registeredMemoryInMiB": 3646.1,
"registeredGpu": 1,
"containerInstanceId": "abcdefg",
"registrationStatus": "Registered",
"createdAt": "2021-10-1T05:51:06.000Z"
}
],
"count": 1,
"kind": "spotinst:ocean:aws:ecs:containerInstances"
}
}

Create VNG

Create a new Ocean ECS virtual node group in the specified account.

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

required

object (oceanClusterLaunchSpec)

AWS Cluster Virtual Node Group (VNG).

	Array of objects[ items ] Add attributes to the cluster.
	object
	Array of objects (launchSpec-blockDeviceMappings) [ items ] Block devices that are exposed to the instance. You can specify virtual devices and EBS volumes. This parameter and rootVolumeSize cannot be in the configuration at the same time. This parameter can be null, but if not null, it must contain at least one block device.
	Array of arn (string) or name (string)[ items ] The instance profile iamRole object.
imageId required	string Set image identifier. Can be null.
	object (instanceMetadataOptions) Ocean instance metadata options object for IMDSv2.
instanceTypes	Array of strings An array of supported instance types for the VNG.
name required	string User given name of the virtual node group.
oceanId required	string The Ocean cluster identifier. Required for to create a virtual node group.
restrictScaleDown	boolean When set to True, the VNG container instances will be treated as if all tasks running have the restrict-scale-down label. Therefore, Ocean will not scale down container instances unless they are empty.
	object (Ocean Scheduling) An object used to define scheduled tasks such as a manual headroom update.
securityGroupIds	Array of strings Set security groups. Each element in array should be a security group identifier.
	object Similar to a strategy for an Ocean cluster, but applying only to a virtual node group.
subnetIds	Array of strings Set the subnets in the VNG. Each element in the array should be a subnet identifier.
	Array of objects[ items ] List of kay-value pairs of tags.
userData	string <byte> Base64-encoded MIME user data to make available to the instances.

Responses

Request samples

Payload

Content type

application/json

{"launchSpec": {"oceanId": "o-1234abcd",
"name": "mySpecLauncher",
"imageId": "img2",
"userData": "dXNlcmJhc2g2NGVuY29kZWQ=",
"securityGroupIds": ["sg1, sg3"
],
"instanceTypes": ["c3.2xlarge, c4.2xlarge"
],
"subnetIds": ["subnet-01234566789abcdef, subnet-9876543210ghijkl"
],
"iamInstanceProfile": ["arn:aws:iam::123456789123:instance-profile"
],
"attributes": [{"key": "key1",
"value": "value1"
}
],
"autoScale": {"headrooms": [{"cpuPerUnit": 1024,
"memoryPerUnit": 512,
"numOfUnits": 2
}
]
},
"tags": [{"tagKey": "Creator",
"tagValue": "John Doe"
}
],
"blockDeviceMappings": [{"deviceName": "/dev/xvda",
"ebs": {"throughput": 125,
"deleteOnTermination": false,
"encrypted": false,
"iops": 1,
"kmsKeyId": "alias/aws/ebs",
"snapshotId": "snap-abcdefghi111110",
"volumeType": "gp2",
"volumeSize": 0,
"dynamicVolumeSize": {"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
}
}
}
],
"restrictScaleDown": false,
"instanceMetadataOptions": {"httpTokens": "optional",
"httpPutResponseHopLimit": 12
},
"scheduling": {"tasks": [{"isEnabled": true,
"cronExpression": "0 1 * * *",
"taskType": "manualHeadroomUpdate",
"config": {"headrooms": [{"cpuPerUnit": 1024,
"memoryPerUnit": 512,
"numOfUnits": 2
}
]
}
}
]
},
"strategy": {"spotPercentage": 70
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/aws/ecs/launchSpec",
"method": "POST",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "ols-1234abcd",
"oceanId": "o-1234abcd",
"name": "mySpecLauncher",
"imageId": "img2",
"userData": "dXNlcmJhc2g2NGVuY29kZWQ=",
"securityGroupIds": ["sg1, sg3"
],
"instanceTypes": ["c3.2xlarge, c4.2xlarge"
],
"subnetIds": ["subnet-01234566789abcdef, subnet-9876543210ghijkl"
],
"iamInstanceProfile": ["arn:aws:iam::123456789123:instance-profile"
],
"attributes": [{"key": "key1",
"value": "value1"
}
],
"autoScale": {"headrooms": [{"cpuPerUnit": 1024,
"memoryPerUnit": 512,
"numOfUnits": 2
}
]
},
"tags": [{"tagKey": "Creator",
"tagValue": "John Doe"
}
],
"blockDeviceMappings": [{"deviceName": "/dev/xvda",
"ebs": {"throughput": 125,
"deleteOnTermination": false,
"encrypted": false,
"iops": 1,
"kmsKeyId": "alias/aws/ebs",
"snapshotId": "snap-abcdefghi111110",
"volumeType": "gp2",
"volumeSize": 0,
"dynamicVolumeSize": {"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
}
}
}
],
"restrictScaleDown": false,
"instanceMetadataOptions": {"httpTokens": "optional",
"httpPutResponseHopLimit": 12
},
"scheduling": {"tasks": [{"isEnabled": true,
"cronExpression": "0 1 * * *",
"taskType": "manualHeadroomUpdate",
"config": {"headrooms": [{"cpuPerUnit": 1024,
"memoryPerUnit": 512,
"numOfUnits": 2
}
]
}
}
]
},
"strategy": {"spotPercentage": 70
},
"createdAt": "2019-06-03T08:13:08.000Z",
"updatedAt": "2019-06-10T15:06:13.000Z"
}
],
"count": 1,
"kind": "spotinst:ocean:aws:ecs:launchSpec"
}
}

List VNGs

Get all the custom VNGs for all Ocean clusters in the specified account.

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/aws/ecs/launchSpec",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "ols-1234abcd",
"oceanId": "o-1234abcd",
"name": "mySpecLauncher",
"imageId": "img2",
"userData": "dXNlcmJhc2g2NGVuY29kZWQ=",
"securityGroupIds": ["sg1, sg3"
],
"instanceTypes": ["c3.2xlarge, c4.2xlarge"
],
"subnetIds": ["subnet-01234566789abcdef, subnet-9876543210ghijkl"
],
"iamInstanceProfile": ["arn:aws:iam::123456789123:instance-profile"
],
"attributes": [{"key": "key1",
"value": "value1"
}
],
"autoScale": {"headrooms": [{"cpuPerUnit": 1024,
"memoryPerUnit": 512,
"numOfUnits": 2
}
]
},
"tags": [{"tagKey": "Creator",
"tagValue": "John Doe"
}
],
"blockDeviceMappings": [{"deviceName": "/dev/xvda",
"ebs": {"throughput": 125,
"deleteOnTermination": false,
"encrypted": false,
"iops": 1,
"kmsKeyId": "alias/aws/ebs",
"snapshotId": "snap-abcdefghi111110",
"volumeType": "gp2",
"volumeSize": 0,
"dynamicVolumeSize": {"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
}
}
}
],
"restrictScaleDown": false,
"instanceMetadataOptions": {"httpTokens": "optional",
"httpPutResponseHopLimit": 12
},
"scheduling": {"tasks": [{"isEnabled": true,
"cronExpression": "0 1 * * *",
"taskType": "manualHeadroomUpdate",
"config": {"headrooms": [{"cpuPerUnit": 1024,
"memoryPerUnit": 512,
"numOfUnits": 2
}
]
}
}
]
},
"strategy": {"spotPercentage": 70
},
"createdAt": "2019-06-03T08:13:08.000Z",
"updatedAt": "2019-06-10T15:06:13.000Z"
}
],
"count": 1,
"kind": "spotinst:ocean:aws:ecs:launchSpec"
}
}

Get VNG

Get a specific custom launch configuration for an Ocean cluster in the specified account.

Authorizations:

path Parameters

oceanLaunchSpecId

required

string

Ocean cluster launch specification identifier.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/aws/ecs/launchSpec/ols-12345abc",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "ols-1234abcd",
"oceanId": "o-1234abcd",
"name": "mySpecLauncher",
"imageId": "img2",
"userData": "dXNlcmJhc2g2NGVuY29kZWQ=",
"securityGroupIds": ["sg1, sg3"
],
"instanceTypes": ["c3.2xlarge, c4.2xlarge"
],
"subnetIds": ["subnet-01234566789abcdef, subnet-9876543210ghijkl"
],
"iamInstanceProfile": ["arn:aws:iam::123456789123:instance-profile"
],
"attributes": [{"key": "key1",
"value": "value1"
}
],
"autoScale": {"headrooms": [{"cpuPerUnit": 1024,
"memoryPerUnit": 512,
"numOfUnits": 2
}
]
},
"tags": [{"tagKey": "Creator",
"tagValue": "John Doe"
}
],
"blockDeviceMappings": [{"deviceName": "/dev/xvda",
"ebs": {"throughput": 125,
"deleteOnTermination": false,
"encrypted": false,
"iops": 1,
"kmsKeyId": "alias/aws/ebs",
"snapshotId": "snap-abcdefghi111110",
"volumeType": "gp2",
"volumeSize": 0,
"dynamicVolumeSize": {"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
}
}
}
],
"restrictScaleDown": false,
"instanceMetadataOptions": {"httpTokens": "optional",
"httpPutResponseHopLimit": 12
},
"scheduling": {"tasks": [{"isEnabled": true,
"cronExpression": "0 1 * * *",
"taskType": "manualHeadroomUpdate",
"config": {"headrooms": [{"cpuPerUnit": 1024,
"memoryPerUnit": 512,
"numOfUnits": 2
}
]
}
}
]
},
"strategy": {"spotPercentage": 70
},
"createdAt": "2019-06-03T08:13:08.000Z",
"updatedAt": "2019-06-10T15:06:13.000Z"
}
],
"count": 1,
"kind": "spotinst:ocean:aws:ecs:launchSpec"
}
}

Delete VNG

Delete a specified virtual node group in an Ocean cluster.

Authorizations:

path Parameters

oceanLaunchSpecId

required

string

Ocean cluster launch specification identifier.

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
deleteContainerInstances	boolean Default: false Example: deleteContainerInstances=true When set to "true", all instances belonging to the deleted VNG will be drained, detached, and terminated.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/aws/ecs/launchSpec/ols-12345abc",
"method": "DELETE",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Update VNG

Get a specific custom launch configuration for an Ocean cluster in the specified account.

Authorizations:

path Parameters

oceanLaunchSpecId

required

string

Ocean cluster launch specification identifier.

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
autoApplyTags	boolean Default: false Example: autoApplyTags=true Optionally update resource tags on the fly without performing a roll.

Request Body schema: application/json

required

object (oceanClusterLaunchSpec)

AWS Cluster Virtual Node Group (VNG).

	Array of objects[ items ] Add attributes to the cluster.
	object
	Array of objects (launchSpec-blockDeviceMappings) [ items ] Block devices that are exposed to the instance. You can specify virtual devices and EBS volumes. This parameter and rootVolumeSize cannot be in the configuration at the same time. This parameter can be null, but if not null, it must contain at least one block device.
	Array of arn (string) or name (string)[ items ] The instance profile iamRole object.
imageId required	string Set image identifier. Can be null.
	object (instanceMetadataOptions) Ocean instance metadata options object for IMDSv2.
instanceTypes	Array of strings An array of supported instance types for the VNG.
name required	string User given name of the virtual node group.
oceanId required	string The Ocean cluster identifier. Required for to create a virtual node group.
restrictScaleDown	boolean When set to True, the VNG container instances will be treated as if all tasks running have the restrict-scale-down label. Therefore, Ocean will not scale down container instances unless they are empty.
	object (Ocean Scheduling) An object used to define scheduled tasks such as a manual headroom update.
securityGroupIds	Array of strings Set security groups. Each element in array should be a security group identifier.
	object Similar to a strategy for an Ocean cluster, but applying only to a virtual node group.
subnetIds	Array of strings Set the subnets in the VNG. Each element in the array should be a subnet identifier.
	Array of objects[ items ] List of kay-value pairs of tags.
userData	string <byte> Base64-encoded MIME user data to make available to the instances.

Responses

Request samples

Payload

Content type

application/json

{"launchSpec": {"oceanId": "o-1234abcd",
"name": "mySpecLauncher",
"imageId": "img2",
"userData": "dXNlcmJhc2g2NGVuY29kZWQ=",
"securityGroupIds": ["sg1, sg3"
],
"instanceTypes": ["c3.2xlarge, c4.2xlarge"
],
"subnetIds": ["subnet-01234566789abcdef, subnet-9876543210ghijkl"
],
"iamInstanceProfile": ["arn:aws:iam::123456789123:instance-profile"
],
"attributes": [{"key": "key1",
"value": "value1"
}
],
"autoScale": {"headrooms": [{"cpuPerUnit": 1024,
"memoryPerUnit": 512,
"numOfUnits": 2
}
]
},
"tags": [{"tagKey": "Creator",
"tagValue": "John Doe"
}
],
"blockDeviceMappings": [{"deviceName": "/dev/xvda",
"ebs": {"throughput": 125,
"deleteOnTermination": false,
"encrypted": false,
"iops": 1,
"kmsKeyId": "alias/aws/ebs",
"snapshotId": "snap-abcdefghi111110",
"volumeType": "gp2",
"volumeSize": 0,
"dynamicVolumeSize": {"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
}
}
}
],
"restrictScaleDown": false,
"instanceMetadataOptions": {"httpTokens": "optional",
"httpPutResponseHopLimit": 12
},
"scheduling": {"tasks": [{"isEnabled": true,
"cronExpression": "0 1 * * *",
"taskType": "manualHeadroomUpdate",
"config": {"headrooms": [{"cpuPerUnit": 1024,
"memoryPerUnit": 512,
"numOfUnits": 2
}
]
}
}
]
},
"strategy": {"spotPercentage": 70
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/aws/ecs/launchSpec/ols-12345abc",
"method": "PUT",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "ols-1234abcd",
"oceanId": "o-1234abcd",
"name": "mySpecLauncher",
"imageId": "img2",
"userData": "dXNlcmJhc2g2NGVuY29kZWQ=",
"securityGroupIds": ["sg1, sg3"
],
"instanceTypes": ["c3.2xlarge, c4.2xlarge"
],
"subnetIds": ["subnet-01234566789abcdef, subnet-9876543210ghijkl"
],
"iamInstanceProfile": ["arn:aws:iam::123456789123:instance-profile"
],
"attributes": [{"key": "key1",
"value": "value1"
}
],
"autoScale": {"headrooms": [{"cpuPerUnit": 1024,
"memoryPerUnit": 512,
"numOfUnits": 2
}
]
},
"tags": [{"tagKey": "Creator",
"tagValue": "John Doe"
}
],
"blockDeviceMappings": [{"deviceName": "/dev/xvda",
"ebs": {"throughput": 125,
"deleteOnTermination": false,
"encrypted": false,
"iops": 1,
"kmsKeyId": "alias/aws/ebs",
"snapshotId": "snap-abcdefghi111110",
"volumeType": "gp2",
"volumeSize": 0,
"dynamicVolumeSize": {"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
}
}
}
],
"restrictScaleDown": false,
"instanceMetadataOptions": {"httpTokens": "optional",
"httpPutResponseHopLimit": 12
},
"scheduling": {"tasks": [{"isEnabled": true,
"cronExpression": "0 1 * * *",
"taskType": "manualHeadroomUpdate",
"config": {"headrooms": [{"cpuPerUnit": 1024,
"memoryPerUnit": 512,
"numOfUnits": 2
}
]
}
}
]
},
"strategy": {"spotPercentage": 70
},
"createdAt": "2019-06-03T08:13:08.000Z",
"updatedAt": "2019-06-10T15:06:13.000Z"
}
],
"count": 1,
"kind": "spotinst:ocean:aws:ecs:launchSpec"
}
}

Import Fargate To Existing Ocean Cluster

Import a Fargate service into an existing Ocean ECS cluster. Upon Fargate service import, Spot clones the selected Fargate services and runs them with the same VPC & Subnet settings on EC2 spot Instances. Ocean will automatically and seamlessly predict and replace spot instances before they are interrupted, ensuring the uptime of the cluster and providing cost-savings of up to 90% over Fargate-enabled ECS clusters.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-12345abc

Identifier of the Ocean cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

services	Array of strings List of Fargate services by their names. Must contain at least one service.
simpleNewServiceNames	boolean Default: false Flag to align imported service names in the following format: sfm_

Responses

Request samples

Payload

Content type

application/json

{"services": ["service_1",
"service_2"
],
"simpleNewServiceNames": false
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "efm-d235b4d8",
"oceanId": "o-fgdfgdf",
"state": "STARTING",
"config": {"services": ["service_1",
"service_2"
]
},
"simpleNewServiceNames": false
}
],
"count": 1,
"kind": "string"
}
}

Get Fargate Services Discovery

Get existing Fargate services in the ECS cluster.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-12345abc

Identifier of the Ocean cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"ecsClusterName": "EcsTestCluster",
"ecsClusterRegion": "us-east-2",
"serviceNames": [["test_with_1",
"test_without"
]
]
}
],
"count": 1,
"kind": "spotinst:ocean:aws:ecs:fargateMigration:serviceDiscovery"
}
}

Get Fargate Migration Status

Get the status of a Fargate service import.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-12345abc

Identifier of the Ocean cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"ecsClusterName": "EcsTestCluster",
"ecsClusterRegion": "us-east-2",
"state": "FINISHED",
"importedServices": ["test_with_1"
]
}
],
"count": 1,
"kind": "spotinst:ocean:aws:ecs:fargateMigration:status"
}
}

Import Fargate To New Ocean Cluster

This API copies the configuration from a Fargate service into the corresponding fields of an Ocean object. (This process is commonly referred to as importing.) The API returns an Ocean object that is suitable for use in the Create API to create a new Ocean cluster based on your Fargate configuration. If you are migrating a Fargate service that has tags, you must run the Opt In procedure on your Amazon account or IAM role. This is required in order to obtain the necessary Amazon Resource Name (ARN) and resource identifier format for your ECS tasks, container instances, and services. For more information about the required ARN and the Opt In procedure, see the following pages:

The API requires one of the following permissions to be defined in Spot -

Permission: Account Editor (See User Roles) or
Action: ocean:importOceanFromFargate (See Access Policies)

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

ecsClusterName required	string Name of the cluster in ECS.
keyPair	string Specify a key pair to attach to the services.
oceanClusterName required	string Name of the cluster in new Ocean object.
region required	string Name of the AWS region the ECS cluster is in.
services required	Array of Array of strings[ items ] Name of the ECS Fargate service to be imported.
	Array of objects[ items ] Set tags for the service. Items should be unique.

Responses

Request samples

Payload

Content type

application/json

{"oceanClusterName": "fargate-import-ocean",
"ecsClusterName": "fargateTestCluster",
"region": "us-west-1",
"services": [["service_2"
]
],
"keyPair": "spot-prod",
"tags": [{"tagKey": "env",
"tagValue": "prod"
}
]
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"cluster": {"name": "Ocean::my-elastigroup-name",
"clusterName": "my-ECS-cluster-name",
"autoScaler": {"isEnabled": true,
"cooldown": 300,
"attributes": {"key": "the_key",
"value": "the_value"
},
"resourceLimits": {"maxMemoryGib": 1,
"maxVcpu": 1
},
"down": {"evaluationPeriods": 4,
"maxScaleDownPercentage": 20
},
"headroom": {"cpuPerUnit": 2048,
"memoryPerUnit": 3,
"numOfUnits": 2
},
"isAutoConfig": false,
"autoHeadroomPercentage": 20,
"shouldScaleDownNonServiceTasks": true,
"enableAutomaticAndManualHeadroom": false
},
"region": "us-east-1",
"capacity": {"minimum": 1,
"maximum": 10,
"target": 5,
"unit": "instance"
},
"strategy": {"utilizeReservedInstances": true,
"fallbackToOd": true,
"spotPercentage": 100,
"drainingTimeout": 200,
"utilizeCommitments": false
},
"compute": {"subnetIds": ["subnet-1234abcd"
],
"instanceTypes": {"whitelist": ["c4.xlarge",
"c4.2xlarge",
"c4.4xlarge",
"c4.8xlarge"
],
"blacklist": ["r5.large",
"r5.xlarge"
]
},
"launchSpecification": {"associatePublicIpAddress": false,
"associateIpv6Address": false,
"imageId": "ami-123456789abcdefgh",
"securityGroupIds": ["sg-abcdefgh123456789"
],
"iamInstanceProfile": {"arn": "my-arn"
},
"blockDeviceMappings": [{"deviceName": "/dev/xvda",
"ebs": {"throughput": 125,
"deleteOnTermination": false,
"encrypted": false,
"iops": 1,
"kmsKeyId": "alias/aws/ebs",
"snapshotId": "snap-abcdefghi111110",
"volumeType": "gp2",
"volumeSize": 0,
"dynamicVolumeSize": {"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
}
}
}
],
"instanceMetadataOptions": {"httpTokens": "optional",
"httpPutResponseHopLimit": 12,
"httpEndpoint": "disabled"
},
"userData": "Q29udGVudC1UeXBlOiBtdWx0aXBhcnQvbWl4ZWQ7IGJvdW5kYXJ5PSI9PT09PT09PT09PT09PT01MTg5MDY1Mzc3MjIyODk4NDA3PT0iCk1JTUUtVmVyc2lvbjogMS4wCgotLT09PT09PT09PT09PT09PTUxODkwNjUzNzcyMjI4OTg0MDc9PQp",
"useAsTemplateOnly": false
},
"optimizeImage": {"shouldOptimizeEcsAmi": "true",
"performAt": "never",
"timeWindows": ["['Sun:02:00-Sun:12:00', 'Wed:01:01-Fri:02:03']"
]
}
},
"scheduling": {"tasks": [{"isEnabled": false,
"cronExpression": "string",
"taskType": "clusterRoll",
"parameters": {"clusterRoll": {"batchSizePercentage": 20,
"comment": "This is why I deployed my cluster.",
"batchMinHealthyPercentage": 100
}
}
}
],
"shutdownHours": {"timeWindows": ["Sat:08:00-Sun:08:00"
],
"isEnabled": true
}
}
}
}
],
"count": 1,
"kind": "spotinst:ocean:aws:ecs"
}
}

Get Cluster Costs

Describes ECS cluster costs in a time range.
The response will provide the distribution of the costs per cluster.

Authorizations:

path Parameters

clusterName

required

string

Example: ocean.ecs

The name of the ECS cluster, as set in the Ocean cluster configuration under the "clusterName" field.

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
fromDate required	string Beginning date value using either the date format "yyyy-mm-dd; 2016-11-20" or ms "1494751821472".
region required	string Example: region=us-east-1 Region name.
toDate required	string End date value using either the date format "yyyy-mm-dd; 2016-11-20" or ms "1494751821472".

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/mcs/ecs/cluster/my-cluster-identifier/costs",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"totalCost": 279.9907,
"headroomCost": 279.9907,
"standAloneTasksCost": 0,
"ecsGroups": [{"name": "default",
"cost": 18.00862,
"type": "SERVICE"
}
]
}
],
"count": 1,
"kind": "string"
}
}

Launch Container Instances In VNG

Launch container instances in virtual node group.

Authorizations:

path Parameters

oceanLaunchSpecId

required

string

Ocean cluster launch specification identifier.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

object (Ocean ECS VNG Launch Request)

amount

required

integer

The number of container instances to launch.

Responses

Request samples

Payload

Content type

application/json

{"launchRequest": {"amount": 5
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/aws/ecs/launchSpec/ols-12345abc/launchContainerInstances",
"method": "PUT",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"newInstances": [{"instanceId": "i-08d53d2a1dcede08f",
"availabilityZone": "us-west-2b",
"instanceType": "c3.xlarge",
"lifeCycle": "spot"
}
]
}
],
"count": 1,
"kind": "spotinst:ocean:aws:ecs:launchSpec:launchContainerInstances",
"launchSpecId": "ols-f73821bc"
}
}

Ocean GKE

Ocean - Serverless containers for Google Kubernetes Engine

Get Heartbeat Status

Get the heartbeat status of the Ocean Controller for the cluster.
The response returns the heartbeat status and the last heartbeat timestamp.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-abcd1234

Identifier of the Ocean cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/k8s/cluster/o-e0a2bd7c/controllerHeartbeat",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"status": "ACTIVE",
"lastHeartbeat": "2019-11-24T14:33:00.746Z"
}
],
"count": 1,
"kind": "spotinst:ocean:k8s:cluster:controllerHeartbeat"
}
}

Get Cluster Costs

Authorizations:

path Parameters

clusterIdentifier

required

string

Example: ocean.k8s

The reporting identifier of the Ocean Controller as set in the cluster configuration under the "controllerClusterId" field.

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
aggregationPeriod	string The time segment over which data is calculated and displayed. The period may be "daily" or null. If you use "daily" the costs will be broken into parts, e.g., the cost per each day in the period. Otherwise, there will be only one cost per resource for the whole period.
fromDate required	string Beginning date value using either the date format "yyyy-mm-dd; 2016-11-20" or ms "1494751821472".
toDate required	string End date value using either the date format "yyyy-mm-dd; 2016-11-20" or ms "1494751821472".

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/mcs/kubernetes/cluster/my-cluster-identifier/costs",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"totalCost": 279.9907,
"totalComputeCost": 279.9907,
"totalEbsCost": 0,
"totalStorageCost": 0,
"namespaces": {"namespace": "default",
"cost": 18.00862,
"computeCost": 18.00862,
"ebsCost": 0,
"storageCost": 0,
"labels": {"region": "west",
"env": "prod"
},
"annotations": {"region": "west",
"env": "prod"
},
"deployments": {"name": "cpu-deployment-check5",
"namespace": "default",
"cost": 3.7410312,
"computeCost": 3.7410312,
"ebsCost": 0,
"storageCost": 0,
"labels": {"region": "west",
"env": "prod"
},
"annotations": {"region": "west",
"env": "prod"
}
},
"statefulSets": {"name": "cpu-deployment-check5",
"namespace": "default",
"cost": 3.7410312,
"computeCost": 3.7410312,
"ebsCost": 0,
"storageCost": 0,
"labels": {"region": "west",
"env": "prod"
},
"annotations": {"region": "west",
"env": "prod"
}
},
"daemonSets": {"name": "cpu-deployment-check5",
"namespace": "default",
"cost": 3.7410312,
"computeCost": 3.7410312,
"ebsCost": 0,
"storageCost": 0,
"labels": {"region": "west",
"env": "prod"
},
"annotations": {"region": "west",
"env": "prod"
}
},
"jobs": {"name": "cpu-deployment-check5",
"namespace": "default",
"cost": 3.7410312,
"computeCost": 3.7410312,
"ebsCost": 0,
"storageCost": 0,
"labels": {"region": "west",
"env": "prod"
},
"annotations": {"region": "west",
"env": "prod"
}
},
"standAlonePodsCost": 0
},
"deployments": {"name": "cpu-deployment-check5",
"namespace": "default",
"cost": 3.7410312,
"computeCost": 3.7410312,
"ebsCost": 0,
"storageCost": 0,
"labels": {"region": "west",
"env": "prod"
},
"annotations": {"region": "west",
"env": "prod"
}
},
"headroomCost": 0,
"idleCost": 216.10321
}
],
"count": 1,
"kind": "string"
}
}

Create Cluster

Prerequisites:

The Ocean Controller is used to monitor the cluster resources and report back to Ocean.| To install the Ocean Controller, complete and run the following script on a machine with the kubectl command line tool installed and configured:

  #!/usr/bin/env bash
  curl -fsSL http://spotinst-public.s3.amazonaws.com/integrations/kubernetes/cluster-controller/scripts/init.sh | \
  SPOTINST_TOKEN=<ENTER YOUR TOKEN HERE> \
  SPOTINST_ACCOUNT=<ENTER YOUR SPOTINST ACCOUNT ID HERE> \
  SPOTINST_CLUSTER_IDENTIFIER=<ENTER YOUR CLUSTER IDENTIFIER HERE> \
  bash

You may need Kubernetes admin privileges for this script to work. To grant yourself admin privileges, run the following command:

  kubectl create clusterrolebinding <clusterName> --clusterrole=cluster-admin --user=<userEmail>

For more information, refer to our controller installation guides. You can install with Helm, Kubectl or Terraform. For more about Ocean and the Ocean Controller, see the documentation here.

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

required

object

The specification of the Ocean cluster.

	object (auto-scaler) The Ocean Kubernetes Autoscaler object.
	object (Capacity Units) Capacity specifications for the Ocean cluster.
required	object (Ocean Compute)
controllerClusterId required	string Enter the Ocean cluster identifier.
	object Use existing GKE cluster.
name required	string Add a name for the Ocean cluster.
	object (Ocean GKE Scheduling) Schedule an action such as a planned shutdown or a cluster roll.
	object (Security)
	object (Ocean Strategy)

Responses

Request samples

Payload

Content type

application/json

{"cluster": {"name": "test",
"controllerClusterId": "test-123124",
"gke": {"clusterName": "test-cluster",
"masterLocation": "us-central1-a"
},
"autoScaler": {"isEnabled": true,
"cooldown": 180,
"resourceLimits": {"maxMemoryGib": 1500,
"maxVcpu": 750
},
"down": {"evaluationPeriods": 3,
"maxScaleDownPercentage": 30
},
"headRoom": {"cpuPerUnit": 0,
"memoryPerUnit": 0,
"gpuPerUnit": 0,
"numOfUnit": 0
},
"isAutoConfig": false,
"autoHeadroomPercentage": null,
"enableAutomaticAndManualHeadroom": true
},
"capacity": {"minimum": 0,
"maximum": 3,
"target": 3
},
"strategy": {"drainingTimeout": 60,
"provisioningModel": "SPOT",
"preemptiblePercentage": 100
},
"scheduling": {"shutdownHours": {"isEnabled": true,
"timeWindows": [["Fri:15:30-Wed:14:30",
"Wed:15:30-Thu:18:30"
]
]
},
"tasks": [{"isEnabled": true,
"cronExpression": "0 1 * * *",
"taskType": "clusterRoll",
"parameters": {"clusterRoll": {"batchSizePercentage": 20,
"comment": "This is why I deployed my cluster.",
"batchMinHealthyPercentage": 100
}
}
}
]
},
"security": {"containerImage": {"approvedImages": [["gce.io/*",
"docker.*"
]
]
}
},
"compute": {"networkInterfaces": {"network": "default",
"projectId": "test-project",
"accessConfigs": {"name": "external-nat",
"type": "ONE_TO_ONE_NAT"
},
"aliasIpRanges": {"ipCidrRange": "/24",
"subnetworkRangeName": "gke-test-native-vpc-pods-5cb557f7"
}
},
"backendServices": {"backendServiceName": "test-global-tcp",
"locationType": "regional",
"scheme": "EXTERNAL",
"namedPorts": {"name": "https",
"ports": [443,
8443
]
}
},
"subnetName": "default",
"availabilityZones": ["us-west1-a"
],
"instanceTypes": {"whitelist": ["n1-standard-2"
],
"blacklist": ["n2d-highcpu-96"
]
},
"launchSpecification": {"sourceImage": "https://www.googleapis.com/compute/v1/projects/gke-node-images/global/images/gke-1117-gke12-cos-69-10895-138-0-v190225-pre",
"metadata": {"key": "example_key1",
"value": "exmample_value1"
},
"tags": ["gke-cluster-name-12345-node"
],
"ipForwarding": true,
"minCpuPlatform": "Intel Sandy Bridge",
"serviceAccount": "265168459660-compute@developer.gserviceaccount.com",
"labels": [{"key": "spotinst-gke-original-node-pool",
"value": "test-native-vpc__default-pool"
}
],
"rootVolumeSizeInGb": 100,
"rootVolumeType": "pd-standard",
"shieldedInstanceConfig": {"enableSecureBoot": true,
"enableIntegrityMonitoring": true
},
"useAsTemplateOnly": false
}
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/gcp/k8s/cluster",
"method": "POST",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "o-abcd1234",
"name": "test",
"controllerClusterId": "test-123124",
"gke": {"clusterName": "test-cluster",
"masterLocation": "us-central1-a"
},
"autoScaler": {"isEnabled": true,
"cooldown": 180,
"resourceLimits": {"maxMemoryGib": 1500,
"maxVcpu": 750
},
"down": {"evaluationPeriods": 3,
"maxScaleDownPercentage": 30
},
"headRoom": {"cpuPerUnit": 0,
"memoryPerUnit": 0,
"gpuPerUnit": 0,
"numOfUnit": 0
},
"isAutoConfig": false,
"autoHeadroomPercentage": null,
"enableAutomaticAndManualHeadroom": true
},
"capacity": {"minimum": 0,
"maximum": 3,
"target": 3
},
"strategy": {"drainingTimeout": 60,
"provisioningModel": "SPOT",
"preemptiblePercentage": 100
},
"scheduling": {"shutdownHours": {"isEnabled": true,
"timeWindows": [["Fri:15:30-Wed:14:30",
"Wed:15:30-Thu:18:30"
]
]
},
"tasks": [{"isEnabled": true,
"cronExpression": "0 1 * * *",
"taskType": "clusterRoll",
"parameters": {"clusterRoll": {"batchSizePercentage": 20,
"comment": "This is why I deployed my cluster.",
"batchMinHealthyPercentage": 100
}
}
}
]
},
"security": {"containerImage": {"approvedImages": [["gce.io/*",
"docker.*"
]
]
}
},
"compute": {"networkInterfaces": {"network": "default",
"projectId": "test-project",
"accessConfigs": {"name": "external-nat",
"type": "ONE_TO_ONE_NAT"
},
"aliasIpRanges": {"ipCidrRange": "/24",
"subnetworkRangeName": "gke-test-native-vpc-pods-5cb557f7"
}
},
"backendServices": {"backendServiceName": "test-global-tcp",
"locationType": "regional",
"scheme": "EXTERNAL",
"namedPorts": {"name": "https",
"ports": [443,
8443
]
}
},
"subnetName": "default",
"availabilityZones": ["us-west1-a"
],
"instanceTypes": {"whitelist": ["n1-standard-2"
],
"blacklist": ["n2d-highcpu-96"
]
},
"launchSpecification": {"sourceImage": "https://www.googleapis.com/compute/v1/projects/gke-node-images/global/images/gke-1117-gke12-cos-69-10895-138-0-v190225-pre",
"metadata": {"key": "example_key1",
"value": "exmample_value1"
},
"tags": ["gke-cluster-name-12345-node"
],
"ipForwarding": true,
"minCpuPlatform": "Intel Sandy Bridge",
"serviceAccount": "265168459660-compute@developer.gserviceaccount.com",
"labels": [{"key": "spotinst-gke-original-node-pool",
"value": "test-native-vpc__default-pool"
}
],
"rootVolumeSizeInGb": 100,
"rootVolumeType": "pd-standard",
"shieldedInstanceConfig": {"enableSecureBoot": true,
"enableIntegrityMonitoring": true
},
"useAsTemplateOnly": false
}
},
"createdAt": "2021-03-17T08:13:08.000Z",
"updatedAt": "2021-03-17T15:06:13.000Z"
}
],
"count": 1,
"kind": "spotinst:ocean:gcp:k8s"
}
}

List Clusters

List the configurations for all Ocean clusters in the specified account.

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/gcp/k8s/cluster",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "o-abcd1234",
"name": "test",
"controllerClusterId": "test-123124",
"gke": {"clusterName": "test-cluster",
"masterLocation": "us-central1-a"
},
"autoScaler": {"isEnabled": true,
"cooldown": 180,
"resourceLimits": {"maxMemoryGib": 1500,
"maxVcpu": 750
},
"down": {"evaluationPeriods": 3,
"maxScaleDownPercentage": 30
},
"headRoom": {"cpuPerUnit": 0,
"memoryPerUnit": 0,
"gpuPerUnit": 0,
"numOfUnit": 0
},
"isAutoConfig": false,
"autoHeadroomPercentage": null,
"enableAutomaticAndManualHeadroom": true
},
"capacity": {"minimum": 0,
"maximum": 3,
"target": 3
},
"strategy": {"drainingTimeout": 60,
"provisioningModel": "SPOT",
"preemptiblePercentage": 100
},
"scheduling": {"shutdownHours": {"isEnabled": true,
"timeWindows": [["Fri:15:30-Wed:14:30",
"Wed:15:30-Thu:18:30"
]
]
},
"tasks": [{"isEnabled": true,
"cronExpression": "0 1 * * *",
"taskType": "clusterRoll",
"parameters": {"clusterRoll": {"batchSizePercentage": 20,
"comment": "This is why I deployed my cluster.",
"batchMinHealthyPercentage": 100
}
}
}
]
},
"security": {"containerImage": {"approvedImages": [["gce.io/*",
"docker.*"
]
]
}
},
"compute": {"networkInterfaces": {"network": "default",
"projectId": "test-project",
"accessConfigs": {"name": "external-nat",
"type": "ONE_TO_ONE_NAT"
},
"aliasIpRanges": {"ipCidrRange": "/24",
"subnetworkRangeName": "gke-test-native-vpc-pods-5cb557f7"
}
},
"backendServices": {"backendServiceName": "test-global-tcp",
"locationType": "regional",
"scheme": "EXTERNAL",
"namedPorts": {"name": "https",
"ports": [443,
8443
]
}
},
"subnetName": "default",
"availabilityZones": ["us-west1-a"
],
"instanceTypes": {"whitelist": ["n1-standard-2"
],
"blacklist": ["n2d-highcpu-96"
]
},
"launchSpecification": {"sourceImage": "https://www.googleapis.com/compute/v1/projects/gke-node-images/global/images/gke-1117-gke12-cos-69-10895-138-0-v190225-pre",
"metadata": {"key": "example_key1",
"value": "exmample_value1"
},
"tags": ["gke-cluster-name-12345-node"
],
"ipForwarding": true,
"minCpuPlatform": "Intel Sandy Bridge",
"serviceAccount": "265168459660-compute@developer.gserviceaccount.com",
"labels": [{"key": "spotinst-gke-original-node-pool",
"value": "test-native-vpc__default-pool"
}
],
"rootVolumeSizeInGb": 100,
"rootVolumeType": "pd-standard",
"shieldedInstanceConfig": {"enableSecureBoot": true,
"enableIntegrityMonitoring": true
},
"useAsTemplateOnly": false
}
},
"createdAt": "2021-03-17T08:13:08.000Z",
"updatedAt": "2021-03-17T15:06:13.000Z"
}
],
"count": 1,
"kind": "spotinst:ocean:gcp:k8s"
}
}

Delete Cluster

Delete a specified Ocean cluster.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-abcd1234

Identifier of the Ocean cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/gcp/k8s/cluster/o-abcd1234",
"method": "DELETE",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Get Cluster

Get the configuration for a specified Ocean cluster.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-abcd1234

Identifier of the Ocean cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/gcp/k8s/cluster/o-abcd1234",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "o-abcd1234",
"name": "test",
"controllerClusterId": "test-123124",
"gke": {"clusterName": "test-cluster",
"masterLocation": "us-central1-a"
},
"autoScaler": {"isEnabled": true,
"cooldown": 180,
"resourceLimits": {"maxMemoryGib": 1500,
"maxVcpu": 750
},
"down": {"evaluationPeriods": 3,
"maxScaleDownPercentage": 30
},
"headRoom": {"cpuPerUnit": 0,
"memoryPerUnit": 0,
"gpuPerUnit": 0,
"numOfUnit": 0
},
"isAutoConfig": false,
"autoHeadroomPercentage": null,
"enableAutomaticAndManualHeadroom": true
},
"capacity": {"minimum": 0,
"maximum": 3,
"target": 3
},
"strategy": {"drainingTimeout": 60,
"provisioningModel": "SPOT",
"preemptiblePercentage": 100
},
"scheduling": {"shutdownHours": {"isEnabled": true,
"timeWindows": [["Fri:15:30-Wed:14:30",
"Wed:15:30-Thu:18:30"
]
]
},
"tasks": [{"isEnabled": true,
"cronExpression": "0 1 * * *",
"taskType": "clusterRoll",
"parameters": {"clusterRoll": {"batchSizePercentage": 20,
"comment": "This is why I deployed my cluster.",
"batchMinHealthyPercentage": 100
}
}
}
]
},
"security": {"containerImage": {"approvedImages": [["gce.io/*",
"docker.*"
]
]
}
},
"compute": {"networkInterfaces": {"network": "default",
"projectId": "test-project",
"accessConfigs": {"name": "external-nat",
"type": "ONE_TO_ONE_NAT"
},
"aliasIpRanges": {"ipCidrRange": "/24",
"subnetworkRangeName": "gke-test-native-vpc-pods-5cb557f7"
}
},
"backendServices": {"backendServiceName": "test-global-tcp",
"locationType": "regional",
"scheme": "EXTERNAL",
"namedPorts": {"name": "https",
"ports": [443,
8443
]
}
},
"subnetName": "default",
"availabilityZones": ["us-west1-a"
],
"instanceTypes": {"whitelist": ["n1-standard-2"
],
"blacklist": ["n2d-highcpu-96"
]
},
"launchSpecification": {"sourceImage": "https://www.googleapis.com/compute/v1/projects/gke-node-images/global/images/gke-1117-gke12-cos-69-10895-138-0-v190225-pre",
"metadata": {"key": "example_key1",
"value": "exmample_value1"
},
"tags": ["gke-cluster-name-12345-node"
],
"ipForwarding": true,
"minCpuPlatform": "Intel Sandy Bridge",
"serviceAccount": "265168459660-compute@developer.gserviceaccount.com",
"labels": [{"key": "spotinst-gke-original-node-pool",
"value": "test-native-vpc__default-pool"
}
],
"rootVolumeSizeInGb": 100,
"rootVolumeType": "pd-standard",
"shieldedInstanceConfig": {"enableSecureBoot": true,
"enableIntegrityMonitoring": true
},
"useAsTemplateOnly": false
}
},
"createdAt": "2021-03-17T08:13:08.000Z",
"updatedAt": "2021-03-17T15:06:13.000Z"
}
],
"count": 1,
"kind": "spotinst:ocean:gcp:k8s"
}
}

Update Cluster

All Ocean parameters are updatable, excluding the Name and controllerClusterId.
This API supports partial updates, so specific fields can be updated separately.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-abcd1234

Identifier of the Ocean cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

required

object (oceanCluster-2)

The specification of the Ocean cluster.

	object (auto-scaler) The Ocean Kubernetes Autoscaler object.
	object (Capacity Units) Capacity specifications for the Ocean cluster.
required	object (Ocean Compute)
controllerClusterId required	string Enter the Ocean cluster identifier.
	object Use existing GKE cluster.
name required	string Add a name for the Ocean cluster.
	object (Ocean GKE Scheduling) Schedule an action such as a planned shutdown or a cluster roll.
	object (Security)
	object (Ocean Strategy)

Responses

Request samples

Payload

Content type

application/json

{"cluster": {"name": "test",
"controllerClusterId": "test-123124",
"gke": {"clusterName": "test-cluster",
"masterLocation": "us-central1-a"
},
"autoScaler": {"isEnabled": true,
"cooldown": 180,
"resourceLimits": {"maxMemoryGib": 1500,
"maxVcpu": 750
},
"down": {"evaluationPeriods": 3,
"maxScaleDownPercentage": 30
},
"headRoom": {"cpuPerUnit": 0,
"memoryPerUnit": 0,
"gpuPerUnit": 0,
"numOfUnit": 0
},
"isAutoConfig": false,
"autoHeadroomPercentage": null,
"enableAutomaticAndManualHeadroom": true
},
"capacity": {"minimum": 0,
"maximum": 3,
"target": 3
},
"strategy": {"drainingTimeout": 60,
"provisioningModel": "SPOT",
"preemptiblePercentage": 100
},
"scheduling": {"shutdownHours": {"isEnabled": true,
"timeWindows": [["Fri:15:30-Wed:14:30",
"Wed:15:30-Thu:18:30"
]
]
},
"tasks": [{"isEnabled": true,
"cronExpression": "0 1 * * *",
"taskType": "clusterRoll",
"parameters": {"clusterRoll": {"batchSizePercentage": 20,
"comment": "This is why I deployed my cluster.",
"batchMinHealthyPercentage": 100
}
}
}
]
},
"security": {"containerImage": {"approvedImages": [["gce.io/*",
"docker.*"
]
]
}
},
"compute": {"networkInterfaces": {"network": "default",
"projectId": "test-project",
"accessConfigs": {"name": "external-nat",
"type": "ONE_TO_ONE_NAT"
},
"aliasIpRanges": {"ipCidrRange": "/24",
"subnetworkRangeName": "gke-test-native-vpc-pods-5cb557f7"
}
},
"backendServices": {"backendServiceName": "test-global-tcp",
"locationType": "regional",
"scheme": "EXTERNAL",
"namedPorts": {"name": "https",
"ports": [443,
8443
]
}
},
"subnetName": "default",
"availabilityZones": ["us-west1-a"
],
"instanceTypes": {"whitelist": ["n1-standard-2"
],
"blacklist": ["n2d-highcpu-96"
]
},
"launchSpecification": {"sourceImage": "https://www.googleapis.com/compute/v1/projects/gke-node-images/global/images/gke-1117-gke12-cos-69-10895-138-0-v190225-pre",
"metadata": {"key": "example_key1",
"value": "exmample_value1"
},
"tags": ["gke-cluster-name-12345-node"
],
"ipForwarding": true,
"minCpuPlatform": "Intel Sandy Bridge",
"serviceAccount": "265168459660-compute@developer.gserviceaccount.com",
"labels": [{"key": "spotinst-gke-original-node-pool",
"value": "test-native-vpc__default-pool"
}
],
"rootVolumeSizeInGb": 100,
"rootVolumeType": "pd-standard",
"shieldedInstanceConfig": {"enableSecureBoot": true,
"enableIntegrityMonitoring": true
},
"useAsTemplateOnly": false
}
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/gcp/k8s/cluster/o-abcd1234",
"method": "PUT",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "o-abcd1234",
"name": "test",
"controllerClusterId": "test-123124",
"gke": {"clusterName": "test-cluster",
"masterLocation": "us-central1-a"
},
"autoScaler": {"isEnabled": true,
"cooldown": 180,
"resourceLimits": {"maxMemoryGib": 1500,
"maxVcpu": 750
},
"down": {"evaluationPeriods": 3,
"maxScaleDownPercentage": 30
},
"headRoom": {"cpuPerUnit": 0,
"memoryPerUnit": 0,
"gpuPerUnit": 0,
"numOfUnit": 0
},
"isAutoConfig": false,
"autoHeadroomPercentage": null,
"enableAutomaticAndManualHeadroom": true
},
"capacity": {"minimum": 0,
"maximum": 3,
"target": 3
},
"strategy": {"drainingTimeout": 60,
"provisioningModel": "SPOT",
"preemptiblePercentage": 100
},
"scheduling": {"shutdownHours": {"isEnabled": true,
"timeWindows": [["Fri:15:30-Wed:14:30",
"Wed:15:30-Thu:18:30"
]
]
},
"tasks": [{"isEnabled": true,
"cronExpression": "0 1 * * *",
"taskType": "clusterRoll",
"parameters": {"clusterRoll": {"batchSizePercentage": 20,
"comment": "This is why I deployed my cluster.",
"batchMinHealthyPercentage": 100
}
}
}
]
},
"security": {"containerImage": {"approvedImages": [["gce.io/*",
"docker.*"
]
]
}
},
"compute": {"networkInterfaces": {"network": "default",
"projectId": "test-project",
"accessConfigs": {"name": "external-nat",
"type": "ONE_TO_ONE_NAT"
},
"aliasIpRanges": {"ipCidrRange": "/24",
"subnetworkRangeName": "gke-test-native-vpc-pods-5cb557f7"
}
},
"backendServices": {"backendServiceName": "test-global-tcp",
"locationType": "regional",
"scheme": "EXTERNAL",
"namedPorts": {"name": "https",
"ports": [443,
8443
]
}
},
"subnetName": "default",
"availabilityZones": ["us-west1-a"
],
"instanceTypes": {"whitelist": ["n1-standard-2"
],
"blacklist": ["n2d-highcpu-96"
]
},
"launchSpecification": {"sourceImage": "https://www.googleapis.com/compute/v1/projects/gke-node-images/global/images/gke-1117-gke12-cos-69-10895-138-0-v190225-pre",
"metadata": {"key": "example_key1",
"value": "exmample_value1"
},
"tags": ["gke-cluster-name-12345-node"
],
"ipForwarding": true,
"minCpuPlatform": "Intel Sandy Bridge",
"serviceAccount": "265168459660-compute@developer.gserviceaccount.com",
"labels": [{"key": "spotinst-gke-original-node-pool",
"value": "test-native-vpc__default-pool"
}
],
"rootVolumeSizeInGb": 100,
"rootVolumeType": "pd-standard",
"shieldedInstanceConfig": {"enableSecureBoot": true,
"enableIntegrityMonitoring": true
},
"useAsTemplateOnly": false
}
},
"createdAt": "2021-03-17T08:13:08.000Z",
"updatedAt": "2021-03-17T15:06:13.000Z"
}
],
"count": 1,
"kind": "spotinst:ocean:gcp:k8s"
}
}

Reimport Cluster

Reimport the cluster's configuration from GKE.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-abcd1234

Identifier of the Ocean cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/gcp/k8s/cluster/o-12345abc/reImport",
"method": "PUT",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"cluster": {"oceanId": "o-12345abc",
"associatedClusterName": "gke-cluster",
"isUpdated": true,
"launchSpecs": [{"launchSpecId": "ols-12345abc",
"associatedNodePool": "default-pool",
"isUpdated": true
},
{"launchSpecId": "ols-98765cba",
"associatedNodePool": "pool-1",
"isUpdated": false
}
]
}
}
],
"count": 1,
"kind": "spotinst:ocean:gcp:k8s"
}
}

Get Elastilog

Get group’s Elastilog by

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-abcd1234

Identifier of the Ocean cluster.

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
fromDate required	string Beginning date value using either the date format "yyyy-mm-dd; 2016-11-20" or ms "1494751821472".
LIMIT	integer <= 1000 Default: 500 Example: LIMIT=200 Maximum number of lines to extract in a response.
resourceId	string Example: resourceId=i-12345678 Filter extracted log entries for a specific resource identifier. Default: Null
SEVERITY	string Default: "ALL" Enum: "ALL" "INFO" "DEBUG" "WARN" Example: SEVERITY=INFO Severity of log entries to extract.
toDate required	string End date value using either the date format "yyyy-mm-dd; 2016-11-20" or ms "1494751821472".

Responses

Response samples

Content type

application/json

{"request": {"id": "3213f42e-455e-4801-a185-cd3eb65fac5f",
"url": "/ocean/gcp/k8s/cluster/o-e0a2bd7c/log?fromDate=2020-10-06&toDate=2020-10-08&severity=ALL&limit=500",
"method": "GET",
"timestamp": "2020-10-05T16:20:38.579Z"
},
"response": {"status": {"code": "200",
"message": "OK"
},
"kind": "spotinst:ocean:cluster:log",
"items": [{"message": "Ocean o-e0a2bd7c successfully created.",
"severity": "INFO",
"createdAt": "2020-10-07T09:51:12.000Z"
}
],
"count": "1"
}
}

Get Right Sizing Recommendations

Get right-sizing recommendations for an Ocean cluster and filter them according to namespace or label.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-abcd1234

Identifier of the Ocean cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

object

Optional - may be null.

	object Optional - may be null.
namespaces	Array of strings Optional - may be null. If exists - should contain at least 1 item.

Responses

Request samples

Payload

Content type

application/json

{"filter": {"namespaces": ["sparkSpace",
"kube-system"
],
"attribute": {"type": "label",
"key": "app",
"operator": "Equals",
"value": "redis"
}
}
}

Response samples

Content type

application/json

{"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:ocean:aws:k8s:cluster:rightSizing:resourceSuggestion",
"items": [{"resourceName": "dns-controller",
"resourceType": "deployment",
"namespace": "kube-system",
"suggestedCPU": 1,
"suggestedMemory": 19,
"requestedCPU": 50,
"requestedMemory": 50
},
{"resourceName": "kube-dns",
"resourceType": "daemonSet",
"namespace": "kube-system",
"suggestedCPU": 2,
"suggestedMemory": 20,
"requestedCPU": 10,
"requestedMemory": 30
}
],
"count": 2
}
}

Create VNG

Create a virtual node group.

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

required

object (oceanClusterLaunchSpec-3)

Ocean Cluster Virtual Node Group (VNG).

	object
availabilityZones	Array of strings An array holding availability zones, this configures the availability zones the Ocean may launch instances in per VNG. Can be null.
instanceTypes	Array of strings An array of supported machine types for the virtual node group. Can be null.
	Array of objects[ items ] An array of labels to add to the virtual node group. Only custom user labels are allowed, and not Kubernetes built-in labels or Spot internal labels.
	Array of objects[ items ] Add metadata to the cluster.
name	string Set the name for the virtual node group.
oceanId required	string The Ocean cluster identifier. Required to create the virtual node group.
	object
restrictScaleDown	boolean When set to True, VNG nodes will be treated as if all pods running have the restrict-scale-down label. Therefore, Ocean will not scale nodes down unless they are empty.
rootVolumeSize	integer Set root volume size (in GB).
rootVolumeType	string Enum: "pd-standard" "pd-ssd" Set the root volume disk type.
	object (Ocean Scheduling) An object used to define scheduled tasks such as a manual headroom update.
serviceAccount	string The account used by applications running on the VM to call GCP APIs.
	object (shielded-instance-config) The Ocean shielded instance configuration object.
sourceImage required	string Set the image URL. Can be null.
	object (storage) The Ocean virtual node group storage object.
	object (strategy) The Ocean virtual node group strategy object.
tags	Array of strings Every node launched from this VNG will have those tags. If the value is null, the nodes will have the tags configured at the cluster level.
	Array of objects[ items ] Add taints to the virtual node group.

Responses

Request samples

Payload

Content type

application/json

{"launchSpec": {"oceanId": "o-1fff54ed",
"name": "lp_name",
"sourceImage": "https://www.googleapis.com/compute/v1/projects/gke-node-images/global/images/container-v1-3-v20160517",
"serviceAccount": "265168459660-compute@developer.gserviceaccount.com",
"rootVolumeSize": 8,
"rootVolumeType": "pd-standard",
"metadata": [{"key": "key1",
"value": "value1"
},
{"key": "key2",
"value": "value2"
}
],
"instanceTypes": ["n1-standard-1",
"n1-standard-2"
],
"availabilityZones": ["us-central1-a",
"us-central1-b"
],
"tags": ["gke-cluster-name-12345-node",
"network-tag-1"
],
"taints": [{"key": "taintKey",
"value": "taintValue",
"effect": "NoSchedule"
}
],
"labels": [{"key": "env",
"value": "test"
}
],
"autoScale": {"headrooms": [{"cpuPerUnit": 1000,
"memoryPerUnit": 2048,
"gpuPerUnit": 0,
"numOfUnits": 3
}
],
"autoHeadroomPercentage": 20
},
"resourceLimits": {"maxInstanceCount": 5,
"minInstanceCount": 2
},
"restrictScaleDown": false,
"shieldedInstanceConfig": {"enableSecureBoot": true,
"enableIntegrityMonitoring": true
},
"strategy": {"preemptiblePercentage": 80
},
"storage": {"localSsdCount": 2
},
"scheduling": {"tasks": [{"isEnabled": true,
"cronExpression": "0 1 * * *",
"taskType": "manualHeadroomUpdate",
"config": {"headrooms": [{"cpuPerUnit": 1024,
"memoryPerUnit": 512,
"gpuPerUnit": 0,
"numOfUnits": 1
}
]
}
}
]
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/gcp/k8s/launchSpec",
"method": "POST",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"oceanId": "o-1fff54ed",
"name": "lp_name",
"sourceImage": "https://www.googleapis.com/compute/v1/projects/gke-node-images/global/images/container-v1-3-v20160517",
"serviceAccount": "265168459660-compute@developer.gserviceaccount.com",
"rootVolumeSize": 8,
"rootVolumeType": "pd-standard",
"metadata": [{"key": "key1",
"value": "value1"
},
{"key": "key2",
"value": "value2"
}
],
"instanceTypes": ["n1-standard-1",
"n1-standard-2"
],
"availabilityZones": ["us-central1-a",
"us-central1-b"
],
"tags": ["gke-cluster-name-12345-node",
"network-tag-1"
],
"taints": [{"key": "taintKey",
"value": "taintValue",
"effect": "NoSchedule"
}
],
"labels": [{"key": "env",
"value": "test"
}
],
"autoScale": {"headrooms": [{"cpuPerUnit": 1000,
"memoryPerUnit": 2048,
"gpuPerUnit": 0,
"numOfUnits": 3
}
],
"autoHeadroomPercentage": 20
},
"resourceLimits": {"maxInstanceCount": 5,
"minInstanceCount": 2
},
"restrictScaleDown": false,
"shieldedInstanceConfig": {"enableSecureBoot": true,
"enableIntegrityMonitoring": true
},
"strategy": {"preemptiblePercentage": 80
},
"storage": {"localSsdCount": 2
},
"scheduling": {"tasks": [{"isEnabled": true,
"cronExpression": "0 1 * * *",
"taskType": "manualHeadroomUpdate",
"config": {"headrooms": [{"cpuPerUnit": 1024,
"memoryPerUnit": 512,
"gpuPerUnit": 0,
"numOfUnits": 1
}
]
}
}
]
},
"createdAt": "2019-06-03T08:13:08.000Z",
"updatedAt": "2019-06-10T15:06:13.000Z"
}
],
"count": 1,
"kind": "spotinst:ocean:gcp:k8s:launchSpec"
}
}

List VNGs

Authorizations:

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
oceanId required	string Example: oceanId=o-12345abc Identifier of the Ocean cluster.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/gcp/k8s/launchSpec",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"oceanId": "o-1fff54ed",
"name": "lp_name",
"sourceImage": "https://www.googleapis.com/compute/v1/projects/gke-node-images/global/images/container-v1-3-v20160517",
"serviceAccount": "265168459660-compute@developer.gserviceaccount.com",
"rootVolumeSize": 8,
"rootVolumeType": "pd-standard",
"metadata": [{"key": "key1",
"value": "value1"
},
{"key": "key2",
"value": "value2"
}
],
"instanceTypes": ["n1-standard-1",
"n1-standard-2"
],
"availabilityZones": ["us-central1-a",
"us-central1-b"
],
"tags": ["gke-cluster-name-12345-node",
"network-tag-1"
],
"taints": [{"key": "taintKey",
"value": "taintValue",
"effect": "NoSchedule"
}
],
"labels": [{"key": "env",
"value": "test"
}
],
"autoScale": {"headrooms": [{"cpuPerUnit": 1000,
"memoryPerUnit": 2048,
"gpuPerUnit": 0,
"numOfUnits": 3
}
],
"autoHeadroomPercentage": 20
},
"resourceLimits": {"maxInstanceCount": 5,
"minInstanceCount": 2
},
"restrictScaleDown": false,
"shieldedInstanceConfig": {"enableSecureBoot": true,
"enableIntegrityMonitoring": true
},
"strategy": {"preemptiblePercentage": 80
},
"storage": {"localSsdCount": 2
},
"scheduling": {"tasks": [{"isEnabled": true,
"cronExpression": "0 1 * * *",
"taskType": "manualHeadroomUpdate",
"config": {"headrooms": [{"cpuPerUnit": 1024,
"memoryPerUnit": 512,
"gpuPerUnit": 0,
"numOfUnits": 1
}
]
}
}
]
},
"createdAt": "2019-06-03T08:13:08.000Z",
"updatedAt": "2019-06-10T15:06:13.000Z"
}
],
"count": 1,
"kind": "spotinst:ocean:gcp:k8s:launchSpec"
}
}

Import GKE Node Pool To VNG

Returns an Ocean Virtual Node Group (VNG) configuration based on a given GCP GKE Cluster Node Pool.
The returned value ("Imported VNG") can then be used as input to the Create VNG API in order to create an actual VNG in your Ocean cluster.

Authorizations:

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
nodePoolName required	string Example: nodePoolName=test Name of the Node Pool.
oceanId required	string Example: oceanId=o-12345abc Identifier of the Ocean cluster.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/gcp/k8s/launchSpec/import",
"method": "POST",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"oceanId": "o-1fff54ed",
"sourceImage": "https://www.googleapis.com/compute/v1/projects/gke-node-images/global/images/container-v1-3-v20160517",
"serviceAccount": "265168459660-compute@developer.gserviceaccount.com",
"rootVolumeType": "pd-standard",
"metadata": [{"key": "key1",
"value": "value1"
},
{"key": "key2",
"value": "value2"
}
],
"availabilityZones": ["us-central1-a",
"us-central1-b"
],
"tags": ["gke-cluster-name-12345-node",
"network-tag-1"
],
"taints": [{"key": "taintKey",
"value": "taintValue",
"effect": "NoSchedule"
}
],
"labels": [{"key": "env",
"value": "test"
}
],
"shieldedInstanceConfig": {"enableSecureBoot": true,
"enableIntegrityMonitoring": true
},
"storage": {"localSsdCount": 2
}
}
],
"count": 1,
"kind": "spotinst:ocean:gcp:k8s:launchSpec"
}
}

Delete VNG

Delete a specified virtual node group in an Ocean cluster.

Authorizations:

path Parameters

oceanLaunchSpecId

required

string

Ocean cluster launch specification identifier.

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
deleteNodes	boolean Default: false Example: deleteNodes=true When set to "true", all instances belonging to the deleted launch specification will be drained, detached, and terminated.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/gcp/k8s/launchSpec/ols-12345abc",
"method": "DELETE",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Update VNG

All Ocean parameters in a virtual node group are updatable.

Authorizations:

path Parameters

oceanLaunchSpecId

required

string

Ocean cluster launch specification identifier.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

required

object (GKE Cluster)

	object
availabilityZones	Array of strings An array holding availability zones, this configures the availability zones the Ocean may launch instances in per VNG. Can be null.
instanceTypes	Array of strings An array of supported machine types for the virtual node group. Can be null.
	Array of objects[ items ] An array of labels to add to the virtual node group. Only custom user labels are allowed, and not Kubernetes built-in labels or Spot internal labels.
	Array of objects[ items ] Add metadata to the cluster.
name	string Set name for the virtual node group.
oceanId	string The Ocean cluster identifier. Required to create the virtual node group.
	object
restrictScaleDown	boolean When set to True, VNG nodes will be treated as if all pods running have the restrict-scale-down label. Therefore, Ocean will not scale nodes down unless they are empty.
rootVolumeSize	integer Set root volume size (in GB).
	object (Ocean Scheduling) An object used to define scheduled tasks such as a manual headroom update.
	object (shielded-instance-config) The Ocean shielded instance configuration object.
sourceImage	string Set image URL. Can be null.
	object (storage) The Ocean virtual node group storage object.
	object (strategy) The Ocean virtual node group strategy object.
tags	Array of strings Every node launched from this VNG will have those tags. If the value is null, the nodes will have the tags configured at the cluster level.
	Array of objects[ items ] Add taints to virtual node group.

Responses

Request samples

Payload

Content type

application/json

{"launchSpec": {"oceanId": "o-1fff54ed",
"name": "lp_name",
"sourceImage": "https://www.googleapis.com/compute/v1/projects/gke-node-images/global/images/container-v1-3-v20160517",
"rootVolumeSize": 8,
"metadata": [{"key": "key1",
"value": "value1"
},
{"key": "key2",
"value": "value2"
}
],
"instanceTypes": ["n1-standard-1",
"n1-standard-2"
],
"availabilityZones": ["us-central1-a",
"us-central1-b"
],
"tags": ["gke-cluster-name-12345-node",
"network-tag-1"
],
"taints": [{"key": "taintKey",
"value": "taintValue",
"effect": "NoSchedule"
}
],
"labels": [{"key": "env",
"value": "test"
}
],
"autoScale": {"headroom": {"cpuPerUnit": 1000,
"memoryPerUnit": 2048,
"gpuPerUnit": 0,
"numOfUnits": 3
},
"autoHeadroomPercentage": 20
},
"resourceLimits": {"maxInstanceCount": 5,
"minInstanceCount": 2
},
"restrictScaleDown": false,
"shieldedInstanceConfig": {"enableSecureBoot": true,
"enableIntegrityMonitoring": true
},
"strategy": {"preemptiblePercentage": 80
},
"storage": {"localSsdCount": 2
},
"scheduling": {"tasks": [{"isEnabled": true,
"cronExpression": "0 1 * * *",
"taskType": "manualHeadroomUpdate",
"config": {"headrooms": [{"cpuPerUnit": 1024,
"memoryPerUnit": 512,
"gpuPerUnit": 0,
"numOfUnits": 1
}
]
}
}
]
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/gcp/k8s/launchSpec/ols-12345abc",
"method": "PUT",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"oceanId": "o-1fff54ed",
"name": "lp_name",
"sourceImage": "https://www.googleapis.com/compute/v1/projects/gke-node-images/global/images/container-v1-3-v20160517",
"serviceAccount": "265168459660-compute@developer.gserviceaccount.com",
"rootVolumeSize": 8,
"rootVolumeType": "pd-standard",
"metadata": [{"key": "key1",
"value": "value1"
},
{"key": "key2",
"value": "value2"
}
],
"instanceTypes": ["n1-standard-1",
"n1-standard-2"
],
"availabilityZones": ["us-central1-a",
"us-central1-b"
],
"tags": ["gke-cluster-name-12345-node",
"network-tag-1"
],
"taints": [{"key": "taintKey",
"value": "taintValue",
"effect": "NoSchedule"
}
],
"labels": [{"key": "env",
"value": "test"
}
],
"autoScale": {"headrooms": [{"cpuPerUnit": 1000,
"memoryPerUnit": 2048,
"gpuPerUnit": 0,
"numOfUnits": 3
}
],
"autoHeadroomPercentage": 20
},
"resourceLimits": {"maxInstanceCount": 5,
"minInstanceCount": 2
},
"restrictScaleDown": false,
"shieldedInstanceConfig": {"enableSecureBoot": true,
"enableIntegrityMonitoring": true
},
"strategy": {"preemptiblePercentage": 80
},
"storage": {"localSsdCount": 2
},
"scheduling": {"tasks": [{"isEnabled": true,
"cronExpression": "0 1 * * *",
"taskType": "manualHeadroomUpdate",
"config": {"headrooms": [{"cpuPerUnit": 1024,
"memoryPerUnit": 512,
"gpuPerUnit": 0,
"numOfUnits": 1
}
]
}
}
]
},
"createdAt": "2019-06-03T08:13:08.000Z",
"updatedAt": "2019-06-10T15:06:13.000Z"
}
],
"count": 1,
"kind": "spotinst:ocean:gcp:k8s:launchSpec"
}
}

Get VNG

Authorizations:

path Parameters

oceanLaunchSpecId

required

string

Ocean cluster launch specification identifier.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/gcp/k8s/launchSpec/ols-12345abc",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"oceanId": "o-1fff54ed",
"name": "lp_name",
"sourceImage": "https://www.googleapis.com/compute/v1/projects/gke-node-images/global/images/container-v1-3-v20160517",
"serviceAccount": "265168459660-compute@developer.gserviceaccount.com",
"rootVolumeSize": 8,
"rootVolumeType": "pd-standard",
"metadata": [{"key": "key1",
"value": "value1"
},
{"key": "key2",
"value": "value2"
}
],
"instanceTypes": ["n1-standard-1",
"n1-standard-2"
],
"availabilityZones": ["us-central1-a",
"us-central1-b"
],
"tags": ["gke-cluster-name-12345-node",
"network-tag-1"
],
"taints": [{"key": "taintKey",
"value": "taintValue",
"effect": "NoSchedule"
}
],
"labels": [{"key": "env",
"value": "test"
}
],
"autoScale": {"headrooms": [{"cpuPerUnit": 1000,
"memoryPerUnit": 2048,
"gpuPerUnit": 0,
"numOfUnits": 3
}
],
"autoHeadroomPercentage": 20
},
"resourceLimits": {"maxInstanceCount": 5,
"minInstanceCount": 2
},
"restrictScaleDown": false,
"shieldedInstanceConfig": {"enableSecureBoot": true,
"enableIntegrityMonitoring": true
},
"strategy": {"preemptiblePercentage": 80
},
"storage": {"localSsdCount": 2
},
"scheduling": {"tasks": [{"isEnabled": true,
"cronExpression": "0 1 * * *",
"taskType": "manualHeadroomUpdate",
"config": {"headrooms": [{"cpuPerUnit": 1024,
"memoryPerUnit": 512,
"gpuPerUnit": 0,
"numOfUnits": 1
}
]
}
}
]
},
"createdAt": "2019-06-03T08:13:08.000Z",
"updatedAt": "2019-06-10T15:06:13.000Z"
}
],
"count": 1,
"kind": "spotinst:ocean:gcp:k8s:launchSpec"
}
}

Initiate Roll

Roll an entire Ocean cluster or roll subsets of the cluster by specifying launchSpecIds or instanceNames. Performing this request will start the roll immediately, and the roll will take place according to defined batches.

Note that the first response for a successful request will notify about the start of a roll. In order to check the status of a roll, you can use the GET Cluster Roll API using the roll identifier.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-abcd1234

Identifier of the Ocean cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

object

Settings for roll operation

batchMinHealthyPercentage	integer Default: 50 Indicates the threshold of minimum healthy instances in single batch. If the amount of healthy instances in single batch is under the threshold, the cluster roll will fail. If exists, the parameter value will be in range of 1-100. In case of null as value, the default value in the backend will be 50%. Value of param should represent the number in percentage (%) of the batch.
batchSizePercentage	integer Value in % to set the size of the batches in the roll. Valid values are 0-100
comment	string Add a breif description or comment about the roll. The comment should be limited to 256 chars.
instanceNames	Array of strings List of instance names to be rolled. Each name is a string. instanceNames can be null. Cannot be used together with launchSpecIds.
launchSpecIds	Array of strings List of virtual node group identifiers to be rolled. Each identifier is a string. Can be null. Cannot be used together with instanceName.
respectPdb	boolean Default: false During the roll, if the parameter is set to True we honor PDB during the instance replacement.

Responses

Request samples

Payload

Content type

application/json

{"roll": {"batchSizePercentage": 20,
"comment": "This is why I deployed my cluster.",
"respectPdb": true,
"batchMinHealthyPercentage": 100,
"launchSpecIds": [["ols-76694a7d",
"ols-56694a76"
]
],
"instanceNames": [["i-0003a99ffb566f039",
"i-0567a99ffb566f765"
]
]
}
}

Response samples

Content type

application/json

{"rollId": "roll-1234",
"oceanId": "o-12e31234",
"status": "IN_PROGRESS",
"batchNumber": 1,
"numOfBatches": 5,
"comment": "This is why I deployed my cluster.",
"respectPdb": true,
"progress": {"unit": "percentage",
"value": 0,
"detailedStatus": {"oldInstances": [{"instanceName": "sin-0a4becc0-sig-1234abcd",
"status": "REPLACED"
},
{"instanceName": "sin-1a4becc0-sig-1234abcd",
"status": "TO_BE_REPLACED"
},
{"instanceName": "sin-2a4becc0-sig-1234abcd",
"status": "COULD_NOT_BE_REPLACED"
},
{"instanceName": "sin-3a4becc0-sig-1234abcd",
"status": "NOT_REPLACED_DUE_TO_PDB"
}
]
}
},
"instanceNames": ["sin-0a4becc0-sig-6952238d",
"sin-0542ecc0-sig-695223r4"
],
"launchSpecIds": ["ols-76694a7d",
"ols-56694a76"
],
"batchMinHealthyPercentage": 100,
"createdAt": "2019-03-24T15:46:09.000Z",
"updatedAt": "2019-03-24T15:46:09.000Z"
}

List Rolls

Get status for all rolls of an Ocean cluster.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-abcd1234

Identifier of the Ocean cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:ocean:aws:k8s:cluster:roll",
"items": [{"id": "scr-5aaf854e",
"status": "IN_PROGRESS",
"currentBatch": 2,
"numOfBatches": 2,
"comment": "This is why I deployed my cluster.",
"progress": {"unit": "percentage",
"value": 0,
"detailedStatus": {"oldInstances": [{"instanceName": "sin-0a4becc0-sig-1234abcd",
"status": "REPLACED"
},
{"instanceName": "sin-1a4becc0-sig-1234abcd",
"status": "TO_BE_REPLACED"
},
{"instanceName": "sin-2a4becc0-sig-1234abcd",
"status": "COULD_NOT_BE_REPLACED"
},
{"instanceName": "sin-3a4becc0-sig-1234abcd",
"status": "NOT_REPLACED_DUE_TO_PDB"
}
]
}
},
"batchMinHealthyPercentage": 100,
"oceanId": "o-30681b13",
"launchSpecIds": [["ols-76694a7d",
"ols-56694a76"
]
],
"respectPdb": true,
"createdAt": "2019-03-24T15:46:09.000Z",
"updatedAt": "2019-03-24T15:46:09.000Z"
}
]
}

Update Roll

Update a roll of an Ocean cluster.

Performing the request will stop the next batch in a roll.

Authorizations:

path Parameters

oceanClusterId required	string Example: o-abcd1234 Identifier of the Ocean cluster.
ROLL_ID required	string Example: scr-12345abc Ocean Cluster Roll identifier

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

object

Object that specifies the parameters of a roll (also called a deployment).

status

string

Value: "STOPPED"

Set status of a roll. Valid values: "STOPPED"

Responses

Request samples

Payload

Content type

application/json

{"roll": {"status": "STOPPED"
}
}

Response samples

Content type

application/json

{"rollId": "roll-1234",
"status": "STOPPED",
"batchNumber": 1,
"numOfBatches": 5,
"progress": {"unit": "percentage",
"value": 0,
"detailedStatus": {"oldInstances": [{"instanceName": "sin-0a4becc0-sig-1234abcd",
"status": "REPLACED"
},
{"instanceName": "sin-1a4becc0-sig-1234abcd",
"status": "TO_BE_REPLACED"
},
{"instanceName": "sin-2a4becc0-sig-1234abcd",
"status": "COULD_NOT_BE_REPLACED"
},
{"instanceName": "sin-3a4becc0-sig-1234abcd",
"status": "NOT_REPLACED_DUE_TO_PDB"
}
]
}
},
"batchMinHealthyPercentage": 100,
"oceanId": "o-12e31234",
"respectPdb": true,
"createdAt": "2019-03-24T15:46:09.000Z",
"updatedAt": "2019-03-24T15:46:09.000Z"
}

Get Roll

Get status for roll of an Ocean cluster.

Authorizations:

path Parameters

oceanClusterId required	string Example: o-abcd1234 Identifier of the Ocean cluster.
ROLL_ID required	string Example: scr-12345abc Ocean Cluster Roll identifier

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"rollId": "roll-1234",
"oceanId": "o-12e31234",
"status": "IN_PROGRESS",
"batchNumber": 1,
"numOfBatches": 5,
"comment": "This is why I deployed my cluster.",
"respectPdb": true,
"progress": {"unit": "percentage",
"value": 0,
"detailedStatus": {"oldInstances": [{"instanceName": "sin-0a4becc0-sig-1234abcd",
"status": "REPLACED"
},
{"instanceName": "sin-1a4becc0-sig-1234abcd",
"status": "TO_BE_REPLACED"
},
{"instanceName": "sin-2a4becc0-sig-1234abcd",
"status": "COULD_NOT_BE_REPLACED"
},
{"instanceName": "sin-3a4becc0-sig-1234abcd",
"status": "NOT_REPLACED_DUE_TO_PDB"
}
]
}
},
"instanceNames": ["sin-0a4becc0-sig-6952238d",
"sin-0542ecc0-sig-695223r4"
],
"launchSpecIds": ["ols-76694a7d",
"ols-56694a76"
],
"batchMinHealthyPercentage": 100,
"createdAt": "2019-03-24T15:46:09.000Z",
"updatedAt": "2019-03-24T15:46:09.000Z"
}

Get Cluster Nodes

Get nodes data of an Ocean cluster.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-12345abc

Identifier of the Ocean cluster.

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
instanceName	string Example: instanceName=sin-123 Get a specific node by instance name.
launchSpecId	string Example: launchSpecId=ols-123abc Ocean cluster launch specification identifier.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/gcp/k8s/cluster/o-12345abc/nodes",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"instanceName": "sin-123",
"instanceType": "n1-standard-2",
"availabilityZone": "us-central1-b",
"launchSpecId": "ols-123",
"launchSpecName": "dev-launchSpec",
"lifeCycle": "Preemtible",
"publicIp": "1.2.3.4",
"workloadRequestedMilliCpu": 1320,
"workloadRequestedMemoryInMiB": 500,
"workloadRequestedGpu": 1,
"headroomRequestedMilliCpu": 1320,
"headroomRequestedMemoryInMiB": 512,
"headroomRequestedGpu": 1,
"allocatableMilliCpu": 2000,
"allocatableMemoryInMiB": 3646.1,
"allocatableGpu": 1,
"nodeName": "node-1",
"registrationStatus": "Registered",
"createdAt": "2021-10-1T05:51:06.000Z"
}
],
"count": 1,
"kind": "spotinst:ocean:gcp:k8s:nodes"
}
}

Upgrade Elastigroup To Ocean

Prerequisites | Perform the following validations prior to upgrade executions: | * Group identifier cannot be null. * Group identifier exists in Elastigroup. * Group should be a GKE Elastigroup with defined scaling policy. * Group identifier is already managed by Ocean.

Authorizations:

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
groupId required	string Elastigroup identifier

Responses

Response samples

Content type

application/json

{"request": {"id": "e1aba6b3-d1be-419f-b19a-9542e09716a5",
"url": "/ocean/gcp/k8s/cluster/import?groupId=o-210e0c0b?accountId=act-7461862f",
"method": "GET",
"timestamp": "2019-03-05T15:43:16.306Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:ocean:gcp:k8s",
"items": {"id": "o-9aa80ccb",
"name": "ocean test",
"controllerClusterId": "Test-5837c8ad1",
"gke": {"clusterName": "test-native-vpc",
"masterLocation": "us-central1-a"
},
"capacity": {"minimum": 0,
"maximum": 3,
"target": 3
},
"compute": {"networkInterfaces": {"network": "default",
"accessConfigs": {"name": "external-nat",
"type": "ONE_TO_ONE_NAT"
},
"aliasIpRanges": {"ipCidrRange": "/24",
"subnetworkRangeName": "gke-test-native-vpc-pods-5cb557f7"
}
},
"subnetName": "default",
"instanceTypes": {"whitelist": ["n1-standard-2"
]
},
"launchSpecification": {"sourceImage": "https://www.googleapis.com/compute/v1/projects/gke-node-images/global/images/gke-1117-gke12-cos-69-10895-138-0-v190225-pre",
"metadata": {"key": "example_key1",
"value": "exmample_value1"
},
"tags": ["gke-cluster-name-12345-node"
],
"ipForwarding": true,
"serviceAccount": "265168459660-compute@developer.gserviceaccount.com",
"labels": [{"key": "spotinst-gke-original-node-pool",
"value": "test-native-vpc__default-pool"
}
],
"rootVolumeSizeInGb": 100
},
"availabilityZones": [["us-central1-a"
]
]
},
"createdAt": "2018-11-05T12:55:50.000+0000",
"updatedAt": "2018-11-05T12:58:15.000+0000"
},
"count": 1
}
}

Import GKE Cluster To Ocean

Returns an Ocean Cluster configuration, and optionally Virtual Node Group (VNG) configurations based on a given GKE Cluster and its Node Pools.
The returned values ("Imported Cluster/VNGs") can then be used as inputs to the Create Cluster/VNG APIs in order to create the respectful resources.

Authorizations:

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
clusterName required	string Example: clusterName=test-gke Name of the GKE Cluster.
includeLaunchSpecs	boolean Default: true Example: includeLaunchSpecs=true When set to "true", GKE cluster node pools will be imported to Ocean custom VNG ("customLaunchSpec") configurations.
location required	string Example: location=us-central1-a Location GKE Cluster Master.
nodePoolName	string Example: nodePoolName=test Name of the Node Pool to use as a default for the Cluster configuration.

Request Body schema: application/json

required

object

The specification of the Ocean cluster.

	object (auto-scaler) The Ocean Kubernetes Autoscaler object.
availabilityZones	Array of strings An array holding availability zones, this configures the availability zones the Ocean may launch instances in per VNG. Can be null.
	Array of objects[ items ]
	object (Capacity Units) Capacity specifications for the Ocean cluster.
controllerClusterId	string Enter the Ocean cluster identifier.
	object The type of instances that may or may not be a part of the Ocean cluster.
name required	string Add a name for the Ocean cluster.

Responses

Request samples

Payload

Content type

application/json

{"cluster": {"name": "test",
"controllerClusterId": "test-123124",
"capacity": {"minimum": 0,
"maximum": 3,
"target": 3
},
"instanceTypes": {"whitelist": ["n1-standard-2"
],
"blacklist": ["n2d-highcpu-96"
]
},
"autoScaler": {"isEnabled": true,
"cooldown": 180,
"resourceLimits": {"maxMemoryGib": 1500,
"maxVcpu": 750
},
"down": {"evaluationPeriods": 3,
"maxScaleDownPercentage": 30
},
"headRoom": {"cpuPerUnit": 0,
"memoryPerUnit": 0,
"gpuPerUnit": 0,
"numOfUnit": 0
},
"isAutoConfig": false,
"autoHeadroomPercentage": null,
"enableAutomaticAndManualHeadroom": true
},
"availabilityZones": ["us-central1-a",
"us-central1-b"
],
"backendServices": [{"backendServiceName": "bserv-2",
"locationType": "regional",
"scheme": "EXTERNAL",
"namedPorts": {"name": "https",
"ports": [443,
8443
]
}
}
]
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/gcp/k8s/cluster/gke/import",
"method": "POST",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"cluster": {"name": "test",
"controllerClusterId": "test-123124",
"gke": {"clusterName": "test-cluster",
"masterLocation": "us-central1-a"
},
"autoScaler": {"isEnabled": true,
"cooldown": 180,
"resourceLimits": {"maxMemoryGib": 1500,
"maxVcpu": 750
},
"down": {"evaluationPeriods": 3,
"maxScaleDownPercentage": 30
},
"headRoom": {"cpuPerUnit": 0,
"memoryPerUnit": 0,
"gpuPerUnit": 0,
"numOfUnit": 0
},
"isAutoConfig": false,
"autoHeadroomPercentage": null,
"enableAutomaticAndManualHeadroom": true
},
"capacity": {"minimum": 0,
"maximum": 3,
"target": 3
},
"compute": {"networkInterfaces": {"network": "default",
"projectId": "test-project",
"accessConfigs": {"name": "external-nat",
"type": "ONE_TO_ONE_NAT"
},
"aliasIpRanges": {"ipCidrRange": "/24",
"subnetworkRangeName": "gke-test-native-vpc-pods-5cb557f7"
}
},
"backendServices": {"backendServiceName": "test-global-tcp",
"locationType": "regional",
"scheme": "EXTERNAL",
"namedPorts": {"name": "https",
"ports": [443,
8443
]
}
},
"subnetName": "default",
"availabilityZones": ["us-west1-a"
],
"instanceTypes": {"whitelist": ["n1-standard-2"
],
"blacklist": ["n2d-highcpu-96"
]
},
"launchSpecification": {"sourceImage": "https://www.googleapis.com/compute/v1/projects/gke-node-images/global/images/gke-1117-gke12-cos-69-10895-138-0-v190225-pre",
"metadata": {"key": "example_key1",
"value": "exmample_value1"
},
"tags": ["gke-cluster-name-12345-node"
],
"ipForwarding": true,
"minCpuPlatform": "Intel Sandy Bridge",
"serviceAccount": "265168459660-compute@developer.gserviceaccount.com",
"labels": [{"key": "spotinst-gke-original-node-pool",
"value": "test-native-vpc__default-pool"
}
],
"rootVolumeSizeInGb": 100,
"rootVolumeType": "pd-standard",
"shieldedInstanceConfig": {"enableSecureBoot": true,
"enableIntegrityMonitoring": true
},
"useAsTemplateOnly": false
}
}
},
"customLaunchSpecs": [{"oceanId": "o-1fff54ed",
"sourceImage": "https://www.googleapis.com/compute/v1/projects/gke-node-images/global/images/container-v1-3-v20160517",
"serviceAccount": "265168459660-compute@developer.gserviceaccount.com",
"rootVolumeType": "pd-standard",
"metadata": [{"key": "key1",
"value": "value1"
},
{"key": "key2",
"value": "value2"
}
],
"availabilityZones": ["us-central1-a",
"us-central1-b"
],
"tags": ["gke-cluster-name-12345-node",
"network-tag-1"
],
"taints": [{"key": "taintKey",
"value": "taintValue",
"effect": "NoSchedule"
}
],
"labels": [{"key": "env",
"value": "test"
}
],
"shieldedInstanceConfig": {"enableSecureBoot": true,
"enableIntegrityMonitoring": true
},
"storage": {"localSsdCount": 2
}
}
]
}
],
"count": 1,
"kind": "spotinst:ocean:gcp:k8s"
}
}

Launch Nodes In VNG

Launch nodes in virtual node group.

Authorizations:

path Parameters

oceanLaunchSpecId

required

string

Ocean cluster launch specification identifier.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

object (Ocean GKE Virtual Node Group Launch Request)

amount

required

integer

The number of nodes to launch.

Responses

Request samples

Payload

Content type

application/json

{"launchRequest": {"amount": 5
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/gcp/k8s/launchSpec/ols-12345abc/launchNodes",
"method": "PUT",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"newInstances": [{"instanceName": "sin-00b61aa5dde4-oesg-97499562",
"availabilityZone": "us-west-2b",
"instanceType": "c3.xlarge",
"lifeCycle": "Preemptible"
}
]
}
],
"count": 1,
"kind": "spotinst:ocean:gcp:k8s:launchSpec:launchNodes",
"launchSpecId": "ols-f73821bc"
}
}

Ocean AKS

Ocean - Serverless containers for Azure Kubernetes Service

Get Heartbeat Status

Get the heartbeat status of the Ocean Controller for the cluster.
The response returns the heartbeat status and the last heartbeat timestamp.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-abcd1234

Identifier of the Ocean cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/k8s/cluster/o-e0a2bd7c/controllerHeartbeat",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"status": "ACTIVE",
"lastHeartbeat": "2019-11-24T14:33:00.746Z"
}
],
"count": 1,
"kind": "spotinst:ocean:k8s:cluster:controllerHeartbeat"
}
}

Create Cluster

Creates an Ocean entity according to a given specification.

Prerequisite:

Kubenet-based AKS clusters only: The permissions needed in the Azure managed service identity (MSI) for Ocean to use when provisioning new nodes should be adjusted. Run the displayed script on a workstation with an Owner permissions token for the Azure environment. Learn more.

Notes:

The Ocean Controller is used to monitor the cluster resources and report back to Ocean SaaS. A properly functioning controller is mandatory for Ocean to operate. To install the Controller, run the following script on a machine with kubectl command line tool installed and configured:

#!/usr/bin/env bash
curl -fsSL http://spotinst-public.s3.amazonaws.com/integrations/kubernetes/cluster-controller/scripts/init.sh | \
SPOTINST_TOKEN=<ENTER YOUR TOKEN HERE> \
SPOTINST_ACCOUNT=<ENTER YOUR SPOTINST ACCOUNT ID HERE> \
SPOTINST_CLUSTER_IDENTIFIER=<ENTER YOUR CLUSTER IDENTIFIER HERE> \
bash

It is recommended to import all necessary information from the existing AKS cluster using the Ocean AKS Cluster Import API call and use its output to create a fully configured Ocean cluster.

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

required

object (ocean-cluster)

The Ocean cluster.

required	object AKS cluster configuration. Cannot be updated.
	object (auto-scaler) The Ocean Kubernetes Autoscaler object.
controllerClusterId required	string Enter a unique Ocean cluster identifier. Cannot be updated.
	object (Ocean AKS Health) The Ocean AKS Health object.
name required	string Add a name for the Ocean cluster.
	object (Ocean AKS Strategy) The Ocean AKS Strategy object.
required	object (Ocean AKS Virtual Node Group Template) A default template object for all future Ocean AKS virtual node groups.

Responses

Request samples

Payload

Content type

application/json

{"cluster": {"name": "test",
"controllerClusterId": "test-123124",
"aks": {"name": "test-cluster",
"resourceGroupName": "TestResourceGroup"
},
"autoScaler": {"isEnabled": true,
"resourceLimits": {"maxVcpu": 750,
"maxMemoryGib": 1500
},
"down": {"maxScaleDownPercentage": 30
},
"headroom": {"automatic": {"isEnabled": true,
"percentage": 5
}
}
},
"strategy": {"spotPercentage": 50,
"fallbackToOd": true
},
"health": {"gracePeriod": 600
},
"virtualNodeGroupTemplate": {"vmSizes": {"whitelist": ["standard_ds2_v2"
]
},
"zones": ["1",
"2",
"3"
],
"launchSpecification": {"resourceGroupName": "azureResourceGroup",
"customData": "IyEvYmluL2Jhc2gKZWNobyAidGVzdCI=",
"image": {"marketplace": {"publisher": "OpenLogic",
"offer": "CentOS",
"sku": 7.3,
"version": "7.3-1611"
}
},
"network": {"resourceGroupName": "subnetResourceGroup",
"virtualNetworkName": "vname",
"networkInterfaces": [{"isPrimary": true,
"subnetName": "testSubnet",
"assignPublicIp": true,
"publicIpSku": "Standard",
"securityGroup": {"name": "test",
"resourceGroupName": "test"
},
"enableIPForwarding": true,
"additionalIpConfigurations": [{"name": "test",
"privateIpAddressVersion": "IPv4"
}
]
}
]
},
"login": {"sshPublicKey": "ssh-rsa",
"userName": "spotuser"
},
"loadBalancersConfig": {"loadBalancers": [{"type": "loadBalancer",
"resourceGroupName": "testResourceGroup",
"name": "testLoadBalancer",
"loadBalancerSku": "Standard",
"backendPoolNames": [["testBackendPool1",
"testBackendPool2"
]
]
}
]
},
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"extensions": [{"name": "extensionName",
"type": "customScript",
"publisher": "Microsoft.Azure.Extensions",
"apiVersion": 2,
"minorVersionAutoUpgrade": true,
"publicSettings": { },
"protectedSettings": { }
}
],
"osDisk": {"type": "Standard_LRS",
"sizeGB": 30
},
"maxPods": 30
}
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/azure/k8s/cluster",
"method": "POST",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "o-134abcd",
"name": "test",
"controllerClusterId": "test-123124",
"aks": {"name": "test-cluster",
"resourceGroupName": "TestResourceGroup"
},
"autoScaler": {"isEnabled": true,
"resourceLimits": {"maxVcpu": 750,
"maxMemoryGib": 1500
},
"down": {"maxScaleDownPercentage": 30
},
"headroom": {"automatic": {"isEnabled": true,
"percentage": 5
}
}
},
"strategy": {"spotPercentage": 50,
"fallbackToOd": true
},
"health": {"gracePeriod": 600
},
"virtualNodeGroupTemplate": {"vmSizes": {"whitelist": ["standard_ds2_v2"
]
},
"zones": ["1",
"2",
"3"
],
"launchSpecification": {"resourceGroupName": "azureResourceGroup",
"customData": "IyEvYmluL2Jhc2gKZWNobyAidGVzdCI=",
"image": {"marketplace": {"publisher": "OpenLogic",
"offer": "CentOS",
"sku": 7.3,
"version": "7.3-1611"
}
},
"network": {"resourceGroupName": "subnetResourceGroup",
"virtualNetworkName": "vname",
"networkInterfaces": [{"isPrimary": true,
"subnetName": "testSubnet",
"assignPublicIp": true,
"publicIpSku": "Standard",
"securityGroup": {"name": "test",
"resourceGroupName": "test"
},
"enableIPForwarding": true,
"additionalIpConfigurations": [{"name": "test",
"privateIpAddressVersion": "IPv4"
}
]
}
]
},
"login": {"userName": "spotuser"
},
"loadBalancersConfig": {"loadBalancers": [{"type": "loadBalancer",
"resourceGroupName": "testResourceGroup",
"name": "testLoadBalancer",
"loadBalancerSku": "Standard",
"backendPoolNames": [["testBackendPool1",
"testBackendPool2"
]
]
}
]
},
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"extensions": [{"name": "extensionName",
"type": "customScript",
"publisher": "Microsoft.Azure.Extensions",
"apiVersion": 2,
"minorVersionAutoUpgrade": true,
"publicSettings": { },
"protectedSettings": { }
}
],
"osDisk": {"type": "Standard_LRS",
"sizeGB": 30
},
"maxPods": 30
}
},
"createdAt": "2021-03-17T08:13:08.000Z",
"updatedAt": "2021-03-17T15:06:13.000Z"
}
],
"count": 1,
"kind": "spotinst:ocean:azure:k8s"
}
}

List Clusters

List the configurations for all Ocean clusters in the specified account.

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/azure/k8s/cluster",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "o-134abcd",
"name": "test",
"controllerClusterId": "test-123124",
"aks": {"name": "test-cluster",
"resourceGroupName": "TestResourceGroup"
},
"autoScaler": {"isEnabled": true,
"resourceLimits": {"maxVcpu": 750,
"maxMemoryGib": 1500
},
"down": {"maxScaleDownPercentage": 30
},
"headroom": {"automatic": {"isEnabled": true,
"percentage": 5
}
}
},
"strategy": {"spotPercentage": 50,
"fallbackToOd": true
},
"health": {"gracePeriod": 600
},
"virtualNodeGroupTemplate": {"vmSizes": {"whitelist": ["standard_ds2_v2"
]
},
"zones": ["1",
"2",
"3"
],
"launchSpecification": {"resourceGroupName": "azureResourceGroup",
"customData": "IyEvYmluL2Jhc2gKZWNobyAidGVzdCI=",
"image": {"marketplace": {"publisher": "OpenLogic",
"offer": "CentOS",
"sku": 7.3,
"version": "7.3-1611"
}
},
"network": {"resourceGroupName": "subnetResourceGroup",
"virtualNetworkName": "vname",
"networkInterfaces": [{"isPrimary": true,
"subnetName": "testSubnet",
"assignPublicIp": true,
"publicIpSku": "Standard",
"securityGroup": {"name": "test",
"resourceGroupName": "test"
},
"enableIPForwarding": true,
"additionalIpConfigurations": [{"name": "test",
"privateIpAddressVersion": "IPv4"
}
]
}
]
},
"login": {"userName": "spotuser"
},
"loadBalancersConfig": {"loadBalancers": [{"type": "loadBalancer",
"resourceGroupName": "testResourceGroup",
"name": "testLoadBalancer",
"loadBalancerSku": "Standard",
"backendPoolNames": [["testBackendPool1",
"testBackendPool2"
]
]
}
]
},
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"extensions": [{"name": "extensionName",
"type": "customScript",
"publisher": "Microsoft.Azure.Extensions",
"apiVersion": 2,
"minorVersionAutoUpgrade": true,
"publicSettings": { },
"protectedSettings": { }
}
],
"osDisk": {"type": "Standard_LRS",
"sizeGB": 30
},
"maxPods": 30
}
},
"createdAt": "2021-03-17T08:13:08.000Z",
"updatedAt": "2021-03-17T15:06:13.000Z"
}
],
"count": 1,
"kind": "spotinst:ocean:azure:k8s"
}
}

Get Cluster

Get the configurations for a specified Ocean cluster.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-12345abc

Identifier of the Ocean cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/azure/k8s/cluster/o-12345abc",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "o-134abcd",
"name": "test",
"controllerClusterId": "test-123124",
"aks": {"name": "test-cluster",
"resourceGroupName": "TestResourceGroup"
},
"autoScaler": {"isEnabled": true,
"resourceLimits": {"maxVcpu": 750,
"maxMemoryGib": 1500
},
"down": {"maxScaleDownPercentage": 30
},
"headroom": {"automatic": {"isEnabled": true,
"percentage": 5
}
}
},
"strategy": {"spotPercentage": 50,
"fallbackToOd": true
},
"health": {"gracePeriod": 600
},
"virtualNodeGroupTemplate": {"vmSizes": {"whitelist": ["standard_ds2_v2"
]
},
"zones": ["1",
"2",
"3"
],
"launchSpecification": {"resourceGroupName": "azureResourceGroup",
"customData": "IyEvYmluL2Jhc2gKZWNobyAidGVzdCI=",
"image": {"marketplace": {"publisher": "OpenLogic",
"offer": "CentOS",
"sku": 7.3,
"version": "7.3-1611"
}
},
"network": {"resourceGroupName": "subnetResourceGroup",
"virtualNetworkName": "vname",
"networkInterfaces": [{"isPrimary": true,
"subnetName": "testSubnet",
"assignPublicIp": true,
"publicIpSku": "Standard",
"securityGroup": {"name": "test",
"resourceGroupName": "test"
},
"enableIPForwarding": true,
"additionalIpConfigurations": [{"name": "test",
"privateIpAddressVersion": "IPv4"
}
]
}
]
},
"login": {"userName": "spotuser"
},
"loadBalancersConfig": {"loadBalancers": [{"type": "loadBalancer",
"resourceGroupName": "testResourceGroup",
"name": "testLoadBalancer",
"loadBalancerSku": "Standard",
"backendPoolNames": [["testBackendPool1",
"testBackendPool2"
]
]
}
]
},
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"extensions": [{"name": "extensionName",
"type": "customScript",
"publisher": "Microsoft.Azure.Extensions",
"apiVersion": 2,
"minorVersionAutoUpgrade": true,
"publicSettings": { },
"protectedSettings": { }
}
],
"osDisk": {"type": "Standard_LRS",
"sizeGB": 30
},
"maxPods": 30
}
},
"createdAt": "2021-03-17T08:13:08.000Z",
"updatedAt": "2021-03-17T15:06:13.000Z"
}
],
"count": 1,
"kind": "spotinst:ocean:azure:k8s"
}
}

Update Cluster

All Ocean parameters are updatable, excluding aks and controllerClusterId.
This API supports partial updates, so specific fields can be updated separately.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-12345abc

Identifier of the Ocean cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

required

object (ocean-cluster)

The Ocean cluster.

required	object AKS cluster configuration. Cannot be updated.
	object (auto-scaler) The Ocean Kubernetes Autoscaler object.
controllerClusterId required	string Enter a unique Ocean cluster identifier. Cannot be updated.
	object (Ocean AKS Health) The Ocean AKS Health object.
name required	string Add a name for the Ocean cluster.
	object (Ocean AKS Strategy) The Ocean AKS Strategy object.
required	object (Ocean AKS Virtual Node Group Template) A default template object for all future Ocean AKS virtual node groups.

Responses

Request samples

Payload

Content type

application/json

{"cluster": {"name": "test",
"controllerClusterId": "test-123124",
"aks": {"name": "test-cluster",
"resourceGroupName": "TestResourceGroup"
},
"autoScaler": {"isEnabled": true,
"resourceLimits": {"maxVcpu": 750,
"maxMemoryGib": 1500
},
"down": {"maxScaleDownPercentage": 30
},
"headroom": {"automatic": {"isEnabled": true,
"percentage": 5
}
}
},
"strategy": {"spotPercentage": 50,
"fallbackToOd": true
},
"health": {"gracePeriod": 600
},
"virtualNodeGroupTemplate": {"vmSizes": {"whitelist": ["standard_ds2_v2"
]
},
"zones": ["1",
"2",
"3"
],
"launchSpecification": {"resourceGroupName": "azureResourceGroup",
"customData": "IyEvYmluL2Jhc2gKZWNobyAidGVzdCI=",
"image": {"marketplace": {"publisher": "OpenLogic",
"offer": "CentOS",
"sku": 7.3,
"version": "7.3-1611"
}
},
"network": {"resourceGroupName": "subnetResourceGroup",
"virtualNetworkName": "vname",
"networkInterfaces": [{"isPrimary": true,
"subnetName": "testSubnet",
"assignPublicIp": true,
"publicIpSku": "Standard",
"securityGroup": {"name": "test",
"resourceGroupName": "test"
},
"enableIPForwarding": true,
"additionalIpConfigurations": [{"name": "test",
"privateIpAddressVersion": "IPv4"
}
]
}
]
},
"login": {"sshPublicKey": "ssh-rsa",
"userName": "spotuser"
},
"loadBalancersConfig": {"loadBalancers": [{"type": "loadBalancer",
"resourceGroupName": "testResourceGroup",
"name": "testLoadBalancer",
"loadBalancerSku": "Standard",
"backendPoolNames": [["testBackendPool1",
"testBackendPool2"
]
]
}
]
},
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"extensions": [{"name": "extensionName",
"type": "customScript",
"publisher": "Microsoft.Azure.Extensions",
"apiVersion": 2,
"minorVersionAutoUpgrade": true,
"publicSettings": { },
"protectedSettings": { }
}
],
"osDisk": {"type": "Standard_LRS",
"sizeGB": 30
},
"maxPods": 30
}
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/azure/k8s/cluster/o-12345abc",
"method": "PUT",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "o-134abcd",
"name": "test",
"controllerClusterId": "test-123124",
"aks": {"name": "test-cluster",
"resourceGroupName": "TestResourceGroup"
},
"autoScaler": {"isEnabled": true,
"resourceLimits": {"maxVcpu": 750,
"maxMemoryGib": 1500
},
"down": {"maxScaleDownPercentage": 30
},
"headroom": {"automatic": {"isEnabled": true,
"percentage": 5
}
}
},
"strategy": {"spotPercentage": 50,
"fallbackToOd": true
},
"health": {"gracePeriod": 600
},
"virtualNodeGroupTemplate": {"vmSizes": {"whitelist": ["standard_ds2_v2"
]
},
"zones": ["1",
"2",
"3"
],
"launchSpecification": {"resourceGroupName": "azureResourceGroup",
"customData": "IyEvYmluL2Jhc2gKZWNobyAidGVzdCI=",
"image": {"marketplace": {"publisher": "OpenLogic",
"offer": "CentOS",
"sku": 7.3,
"version": "7.3-1611"
}
},
"network": {"resourceGroupName": "subnetResourceGroup",
"virtualNetworkName": "vname",
"networkInterfaces": [{"isPrimary": true,
"subnetName": "testSubnet",
"assignPublicIp": true,
"publicIpSku": "Standard",
"securityGroup": {"name": "test",
"resourceGroupName": "test"
},
"enableIPForwarding": true,
"additionalIpConfigurations": [{"name": "test",
"privateIpAddressVersion": "IPv4"
}
]
}
]
},
"login": {"userName": "spotuser"
},
"loadBalancersConfig": {"loadBalancers": [{"type": "loadBalancer",
"resourceGroupName": "testResourceGroup",
"name": "testLoadBalancer",
"loadBalancerSku": "Standard",
"backendPoolNames": [["testBackendPool1",
"testBackendPool2"
]
]
}
]
},
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"extensions": [{"name": "extensionName",
"type": "customScript",
"publisher": "Microsoft.Azure.Extensions",
"apiVersion": 2,
"minorVersionAutoUpgrade": true,
"publicSettings": { },
"protectedSettings": { }
}
],
"osDisk": {"type": "Standard_LRS",
"sizeGB": 30
},
"maxPods": 30
}
},
"createdAt": "2021-03-17T08:13:08.000Z",
"updatedAt": "2021-03-17T15:06:13.000Z"
}
],
"count": 1,
"kind": "spotinst:ocean:azure:k8s"
}
}

Delete Cluster

Delete a specified Ocean cluster.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-12345abc

Identifier of the Ocean cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/azure/k8s/cluster/o-12345abc",
"method": "DELETE",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Initiate Roll

Roll an entire Ocean cluster or roll subsets of the cluster by specifying virtualNodeGroupIds or vmNames. Performing this request will start the roll immediately and run it in defined batches. Note that the first response for a successful request will indicate the start of a roll. In order to check the status of a roll, you can use the GET Roll API.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-12345abc

Identifier of the Ocean cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

One of

required

object

Object that specifies the parameters required to initiate a roll (also called a deployment).

batchSizePercentage	integer The size of a batch in a roll, in percentage. Valid values are 0-100.
comment	string Add a comment description for the roll. The comment is limited to 256 characters.

Responses

Request samples

Payload

Content type

application/json

Example

{"roll": {"batchSizePercentage": 25,
"comment": "This is why I deployed my cluster."
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/azure/k8s/cluster/o-12345abc/roll",
"method": "POST",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "acr-5aaf854e",
"oceanId": "o-12e31234",
"status": "IN_PROGRESS",
"currentBatch": 2,
"numOfBatches": 4,
"comment": "This is why I deployed my cluster.",
"progress": {"unit": "percentage",
"value": 25,
"detailedStatus": {"oldVms": [{"vmName": "vm-8f42d8217593",
"status": "REPLACED"
},
{"vmName": "vm-5da87fb0bd21",
"status": "COULD_NOT_BE_REPLACED"
},
{"vmName": "vm-1e50f9fabf2f",
"status": "TO_BE_REPLACED"
},
{"vmName": "vm-9597db5ae6fe",
"status": "TO_BE_REPLACED"
}
]
}
},
"vmNames": ["vm-8f42d8217593",
"vm-5da87fb0bd21",
"vm-1e50f9fabf2f",
"vm-9597db5ae6fe"
],
"virtualNodeGroupIds": ["vng-0950f269",
"vng-0a8bc62a"
],
"createdAt": "2019-03-24T15:46:09.000Z",
"updatedAt": "2019-03-24T15:46:09.000Z"
}
],
"count": 1,
"kind": "spotinst:ocean:azure:k8s:cluster:roll"
}
}

List Rolls

Get status for all rolls of an Ocean cluster.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-12345abc

Identifier of the Ocean cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/azure/k8s/cluster/o-12345abc/roll",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "acr-5aaf854e",
"oceanId": "o-12e31234",
"status": "IN_PROGRESS",
"currentBatch": 2,
"numOfBatches": 4,
"comment": "This is why I deployed my cluster.",
"progress": {"unit": "percentage",
"value": 25,
"detailedStatus": {"oldVms": [{"vmName": "vm-8f42d8217593",
"status": "REPLACED"
},
{"vmName": "vm-5da87fb0bd21",
"status": "COULD_NOT_BE_REPLACED"
},
{"vmName": "vm-1e50f9fabf2f",
"status": "TO_BE_REPLACED"
},
{"vmName": "vm-9597db5ae6fe",
"status": "TO_BE_REPLACED"
}
]
}
},
"vmNames": ["vm-8f42d8217593",
"vm-5da87fb0bd21",
"vm-1e50f9fabf2f",
"vm-9597db5ae6fe"
],
"virtualNodeGroupIds": ["vng-0950f269",
"vng-0a8bc62a"
],
"createdAt": "2019-03-24T15:46:09.000Z",
"updatedAt": "2019-03-24T15:46:09.000Z"
}
],
"count": 1,
"kind": "spotinst:ocean:azure:k8s:cluster:roll"
}
}

Update Roll

Update a roll of an Ocean cluster.

Performing the request will stop the next batch in a roll.

Authorizations:

path Parameters

clusterRollId required	string Example: acr-12345abc Ocean cluster roll identifier.
oceanClusterId required	string Example: o-12345abc Identifier of the Ocean cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

required

object

Object that specifies the roll parameters to update.

status

required

string

Value: "STOPPED"

Set roll status. The only valid value is "STOPPED".

Responses

Request samples

Payload

Content type

application/json

{"roll": {"status": "STOPPED"
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/azure/k8s/cluster/o-12345abc/roll/acr-12345abc",
"method": "PUT",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "acr-5aaf854e",
"oceanId": "o-12e31234",
"status": "STOPPED",
"currentBatch": 2,
"numOfBatches": 4,
"comment": "This is why I deployed my cluster.",
"progress": {"unit": "percentage",
"value": 25,
"detailedStatus": {"oldVms": [{"vmName": "vm-8f42d8217593",
"status": "REPLACED"
},
{"vmName": "vm-5da87fb0bd21",
"status": "COULD_NOT_BE_REPLACED"
},
{"vmName": "vm-1e50f9fabf2f",
"status": "TO_BE_REPLACED"
},
{"vmName": "vm-9597db5ae6fe",
"status": "TO_BE_REPLACED"
}
]
}
},
"vmNames": ["vm-8f42d8217593",
"vm-5da87fb0bd21",
"vm-1e50f9fabf2f",
"vm-9597db5ae6fe"
],
"virtualNodeGroupIds": ["vng-0950f269",
"vng-0a8bc62a"
],
"createdAt": "2019-03-24T15:46:09.000Z",
"updatedAt": "2019-03-24T15:46:09.000Z"
}
],
"count": 1,
"kind": "spotinst:ocean:azure:k8s:cluster:roll"
}
}

Get Roll

Get status for a specific roll of an Ocean cluster.

Authorizations:

path Parameters

clusterRollId required	string Example: acr-12345abc Ocean cluster roll identifier.
oceanClusterId required	string Example: o-12345abc Identifier of the Ocean cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/azure/k8s/cluster/o-12345abc/roll/acr-12345abc",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "acr-5aaf854e",
"oceanId": "o-12e31234",
"status": "IN_PROGRESS",
"currentBatch": 2,
"numOfBatches": 4,
"comment": "This is why I deployed my cluster.",
"progress": {"unit": "percentage",
"value": 25,
"detailedStatus": {"oldVms": [{"vmName": "vm-8f42d8217593",
"status": "REPLACED"
},
{"vmName": "vm-5da87fb0bd21",
"status": "COULD_NOT_BE_REPLACED"
},
{"vmName": "vm-1e50f9fabf2f",
"status": "TO_BE_REPLACED"
},
{"vmName": "vm-9597db5ae6fe",
"status": "TO_BE_REPLACED"
}
]
}
},
"vmNames": ["vm-8f42d8217593",
"vm-5da87fb0bd21",
"vm-1e50f9fabf2f",
"vm-9597db5ae6fe"
],
"virtualNodeGroupIds": ["vng-0950f269",
"vng-0a8bc62a"
],
"createdAt": "2019-03-24T15:46:09.000Z",
"updatedAt": "2019-03-24T15:46:09.000Z"
}
],
"count": 1,
"kind": "spotinst:ocean:azure:k8s:cluster:roll"
}
}

Get Cluster Nodes

Get nodes data of an Ocean cluster.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-12345abc

Identifier of the Ocean cluster.

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
virtualNodeGroupId	string Example: virtualNodeGroupId=vng-12345abc Ocean Virtual Node Group identifier.
vmName	string Example: vmName=vm-123 Get a specific node by vmName.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/azure/k8s/cluster/o-12345abc/nodes",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"vmName": "vm-123",
"vmSize": "standard_a1_v2",
"availabilityZone": "eastus2-1",
"virtualNodeGroupId": "ols-123",
"virtualNodeGroupName": "dev-vng",
"lifeCycle": "Spot",
"publicIp": "1.2.3.4",
"workloadRequestedMilliCpu": 1320,
"workloadRequestedMemoryInMiB": 500,
"workloadRequestedGpu": 1,
"headroomRequestedMilliCpu": 1320,
"headroomRequestedMemoryInMiB": 512,
"headroomRequestedGpu": 1,
"allocatableMilliCpu": 2000,
"allocatableMemoryInMiB": 3646.1,
"allocatableGpu": 1,
"nodeName": "vm-123",
"registrationStatus": "Registered",
"createdAt": "2021-10-1T05:51:06.000Z"
}
],
"count": 1,
"kind": "spotinst:ocean:azure:k8s:nodes"
}
}

Import Cluster

The Import Cluster API call returns a JSON formatted Ocean cluster specification for a given AKS cluster and import identifier. The returned specification is ready to use in the Ocean AKS Cluster Create API call.

Prerequisites:

To initiate the import from AKS, run the following script on a machine with the kubectl command-line tool installed and configured (Ensure the correct context is set in kube config.)

curl -fsSL https://spotinst-public.s3.amazonaws.com/integrations/kubernetes/aks/spot-aks-connector/init.sh | \
bash -s acd-12345678

The import identifier has the prefix “acd-“ followed by eight characters. Use the same identifier as input for this API call.
Learn more about the Import from AKS process.

Authorizations:

path Parameters

acdIdentifier

required

string

Example: acd-12345abc

During the import from AKS to Ocean, the user executes a script that gets data from the AKS cluster and sends it to the Spot API. The acdIdentifier is the identifier that is associated with this data, and it is used to create an Ocean cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

required

object (ocean-cluster-import)

The Ocean cluster import request.

required	object AKS cluster configuration. Cannot be updated.
	object (auto-scaler) The Ocean Kubernetes Autoscaler object.
controllerClusterId required	string Enter a unique Ocean cluster identifier. Cannot be updated.
	object (Ocean AKS Health) The Ocean AKS Health object.
name required	string Add a name for the Ocean cluster.
	object (Ocean AKS Strategy) The Ocean AKS Strategy object.
	object (Ocean AKS Virtual Node Group Template Import) A default template object used for importing an AKS virtual node group to Ocean.

Responses

Request samples

Payload

Content type

application/json

{"cluster": {"name": "test",
"controllerClusterId": "test-123124",
"aks": {"name": "test-cluster",
"resourceGroupName": "TestResourceGroup"
},
"autoScaler": {"isEnabled": true,
"resourceLimits": {"maxVcpu": 750,
"maxMemoryGib": 1500
},
"down": {"maxScaleDownPercentage": 30
},
"headroom": {"automatic": {"isEnabled": true,
"percentage": 5
}
}
},
"strategy": {"spotPercentage": 50,
"fallbackToOd": true
},
"health": {"gracePeriod": 600
},
"virtualNodeGroupTemplate": {"vmSizes": {"whitelist": ["standard_ds2_v2"
]
},
"zones": ["1",
"2",
"3"
]
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/azure/k8s/cluster/aks/import/acd-12345abc",
"method": "POST",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"cluster": {"id": "o-134abcd",
"name": "test",
"controllerClusterId": "test-123124",
"aks": {"name": "test-cluster",
"resourceGroupName": "TestResourceGroup"
},
"autoScaler": {"isEnabled": true,
"resourceLimits": {"maxVcpu": 750,
"maxMemoryGib": 1500
},
"down": {"maxScaleDownPercentage": 30
},
"headroom": {"automatic": {"isEnabled": true,
"percentage": 5
}
}
},
"strategy": {"spotPercentage": 50,
"fallbackToOd": true
},
"health": {"gracePeriod": 600
},
"virtualNodeGroupTemplate": {"vmSizes": {"whitelist": ["standard_ds2_v2"
]
},
"zones": ["1",
"2",
"3"
],
"launchSpecification": {"resourceGroupName": "azureResourceGroup",
"customData": "IyEvYmluL2Jhc2gKZWNobyAidGVzdCI=",
"image": {"marketplace": {"publisher": "OpenLogic",
"offer": "CentOS",
"sku": 7.3,
"version": "7.3-1611"
}
},
"network": {"resourceGroupName": "subnetResourceGroup",
"virtualNetworkName": "vname",
"networkInterfaces": [{"isPrimary": true,
"subnetName": "testSubnet",
"assignPublicIp": true,
"publicIpSku": "Standard",
"securityGroup": {"name": "test",
"resourceGroupName": "test"
},
"enableIPForwarding": true,
"additionalIpConfigurations": [{"name": "test",
"privateIpAddressVersion": "IPv4"
}
]
}
]
},
"login": {"userName": "spotuser"
},
"loadBalancersConfig": {"loadBalancers": [{"type": "loadBalancer",
"resourceGroupName": "testResourceGroup",
"name": "testLoadBalancer",
"loadBalancerSku": "Standard",
"backendPoolNames": [["testBackendPool1",
"testBackendPool2"
]
]
}
]
},
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"extensions": [{"name": "extensionName",
"type": "customScript",
"publisher": "Microsoft.Azure.Extensions",
"apiVersion": 2,
"minorVersionAutoUpgrade": true,
"publicSettings": { },
"protectedSettings": { }
}
],
"osDisk": {"type": "Standard_LRS",
"sizeGB": 30
},
"maxPods": 30
}
},
"createdAt": "2021-03-17T08:13:08.000Z",
"updatedAt": "2021-03-17T15:06:13.000Z"
}
}
],
"count": 1,
"kind": "spotinst:ocean:azure:k8s"
}
}

Detach VMs

Scale down specific virtual machines in an Ocean cluster.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-12345abc

Identifier of the Ocean cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

vmsToDetach

required

Array of strings

Array of virtual machine names to detach.

Responses

Request samples

Payload

Content type

application/json

{"vmsToDetach": ["vm-0fbd69f960db"
]
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/azure/k8s/cluster/o-12345abc/detachVms",
"method": "PUT",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"detachedVms": [{"vmName": "vm-12345"
}
]
}
],
"count": 1,
"kind": "spotinst:ocean:azure:k8s:cluster:detachVms"
}
}

Create Virtual Node Group

Create a virtual node group.

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

required

object (virtualNodeGroupWithMetadata)

	object
	Array of objects[ items ] An array of labels to add to the virtual node group. Only custom user labels are allowed, and not Kubernetes built-in labels or Spot internal labels.
	object
name required	string Enter a name for the virtual node group.
oceanId required	string The Ocean cluster identifier.
	object
	Array of objects[ items ] Add taints to a virtual node group.
vmSizes	Array of strings An Array holding VM sizes, this configures the allowed VM sizes the Ocean may launch per VNG.
zones	Array of strings An Array holding Availability Zones, this configures the availability zones the Ocean may launch instances in per VNG.

Responses

Request samples

Payload

Content type

application/json

{"virtualNodeGroup": {"oceanId": "o-13245abc",
"name": "testVng",
"resourceLimits": {"maxInstanceCount": 5
},
"labels": [{"key": "env",
"value": "test"
}
],
"taints": [{"key": "taintKey",
"value": "taintValue",
"effect": "NoSchedule"
}
],
"vmSizes": ["standard_ds2_v2",
"standard_d2s_v4"
],
"zones": ["1",
"2",
"3"
],
"autoScale": {"headrooms": [{"cpuPerUnit": 1000,
"memoryPerUnit": 2048,
"gpuPerUnit": 0,
"numOfUnits": 3
}
],
"autoHeadroomPercentage": 20
},
"launchSpecification": {"osDisk": {"type": "Standard_LRS",
"sizeGB": 30,
"utilizeEphemeralStorage": true
},
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"maxPods": 30
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/azure/k8s/virtualNodeGroup",
"method": "POST",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "vng-12345abc",
"oceanId": "o-13245abc",
"createdAt": "2021-03-17T08:13:08.000Z",
"updatedAt": "2021-03-17T15:06:13.000Z",
"name": "testVng",
"resourceLimits": {"maxInstanceCount": 5
},
"labels": [{"key": "env",
"value": "test"
}
],
"taints": [{"key": "taintKey",
"value": "taintValue",
"effect": "NoSchedule"
}
],
"vmSizes": ["standard_ds2_v2",
"standard_d2s_v4"
],
"zones": ["1",
"2",
"3"
],
"autoScale": {"headrooms": [{"cpuPerUnit": 1000,
"memoryPerUnit": 2048,
"gpuPerUnit": 0,
"numOfUnits": 3
}
],
"autoHeadroomPercentage": 20
},
"launchSpecification": {"osDisk": {"type": "Standard_LRS",
"sizeGB": 30,
"utilizeEphemeralStorage": true
},
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"maxPods": 30
}
}
],
"count": 1,
"kind": "spotinst:ocean:azure:k8s:virtualNodeGroup"
}
}

List Virtual Node Groups

List the configurations for all virtual node groups in the account or in a specified cluster.

Authorizations:

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
oceanId required	string Example: oceanId=o-12345abc Identifier of the Ocean cluster.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/azure/k8s/virtualNodeGroup",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "vng-12345abc",
"oceanId": "o-13245abc",
"createdAt": "2021-03-17T08:13:08.000Z",
"updatedAt": "2021-03-17T15:06:13.000Z",
"name": "testVng",
"resourceLimits": {"maxInstanceCount": 5
},
"labels": [{"key": "env",
"value": "test"
}
],
"taints": [{"key": "taintKey",
"value": "taintValue",
"effect": "NoSchedule"
}
],
"vmSizes": ["standard_ds2_v2",
"standard_d2s_v4"
],
"zones": ["1",
"2",
"3"
],
"autoScale": {"headrooms": [{"cpuPerUnit": 1000,
"memoryPerUnit": 2048,
"gpuPerUnit": 0,
"numOfUnits": 3
}
],
"autoHeadroomPercentage": 20
},
"launchSpecification": {"osDisk": {"type": "Standard_LRS",
"sizeGB": 30,
"utilizeEphemeralStorage": true
},
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"maxPods": 30
}
}
],
"count": 1,
"kind": "spotinst:ocean:azure:k8s:virtualNodeGroup"
}
}

Get Virtual Node Group

Get the configuration of a specified virtual node group.

Authorizations:

path Parameters

virtualNodeGroupId

required

string

Example: vng-12345abc

Ocean Virtual Node Group identifier.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/azure/k8s/virtualNodeGroup/vng-12345abc",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "vng-12345abc",
"oceanId": "o-13245abc",
"createdAt": "2021-03-17T08:13:08.000Z",
"updatedAt": "2021-03-17T15:06:13.000Z",
"name": "testVng",
"resourceLimits": {"maxInstanceCount": 5
},
"labels": [{"key": "env",
"value": "test"
}
],
"taints": [{"key": "taintKey",
"value": "taintValue",
"effect": "NoSchedule"
}
],
"vmSizes": ["standard_ds2_v2",
"standard_d2s_v4"
],
"zones": ["1",
"2",
"3"
],
"autoScale": {"headrooms": [{"cpuPerUnit": 1000,
"memoryPerUnit": 2048,
"gpuPerUnit": 0,
"numOfUnits": 3
}
],
"autoHeadroomPercentage": 20
},
"launchSpecification": {"osDisk": {"type": "Standard_LRS",
"sizeGB": 30,
"utilizeEphemeralStorage": true
},
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"maxPods": 30
}
}
],
"count": 1,
"kind": "spotinst:ocean:azure:k8s:virtualNodeGroup"
}
}

Update Virtual Node Group

All virtual node group parameters are updatable.

Authorizations:

path Parameters

virtualNodeGroupId

required

string

Example: vng-12345abc

Ocean Virtual Node Group identifier.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

required

object (Ocean AKS Virtual Node Group)

	object
	Array of objects[ items ] An array of labels to add to the virtual node group. Only custom user labels are allowed, and not Kubernetes built-in labels or Spot internal labels.
	object
name required	string Enter a name for the virtual node group.
	object
	Array of objects[ items ] Add taints to a virtual node group.
vmSizes	Array of strings An Array holding VM sizes, this configures the allowed VM sizes the Ocean may launch per VNG.
zones	Array of strings An Array holding Availability Zones, this configures the availability zones the Ocean may launch instances in per VNG.

Responses

Request samples

Payload

Content type

application/json

{"virtualNodeGroup": {"name": "testVng",
"resourceLimits": {"maxInstanceCount": 5
},
"labels": [{"key": "env",
"value": "test"
}
],
"taints": [{"key": "taintKey",
"value": "taintValue",
"effect": "NoSchedule"
}
],
"vmSizes": ["standard_ds2_v2",
"standard_d2s_v4"
],
"zones": ["1",
"2",
"3"
],
"autoScale": {"headrooms": [{"cpuPerUnit": 1000,
"memoryPerUnit": 2048,
"gpuPerUnit": 0,
"numOfUnits": 3
}
],
"autoHeadroomPercentage": 20
},
"launchSpecification": {"osDisk": {"type": "Standard_LRS",
"sizeGB": 30,
"utilizeEphemeralStorage": true
},
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"maxPods": 30
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/azure/k8s/virtualNodeGroup/vng-12345abc",
"method": "PUT",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "vng-12345abc",
"oceanId": "o-13245abc",
"createdAt": "2021-03-17T08:13:08.000Z",
"updatedAt": "2021-03-17T15:06:13.000Z",
"name": "testVng",
"resourceLimits": {"maxInstanceCount": 5
},
"labels": [{"key": "env",
"value": "test"
}
],
"taints": [{"key": "taintKey",
"value": "taintValue",
"effect": "NoSchedule"
}
],
"vmSizes": ["standard_ds2_v2",
"standard_d2s_v4"
],
"zones": ["1",
"2",
"3"
],
"autoScale": {"headrooms": [{"cpuPerUnit": 1000,
"memoryPerUnit": 2048,
"gpuPerUnit": 0,
"numOfUnits": 3
}
],
"autoHeadroomPercentage": 20
},
"launchSpecification": {"osDisk": {"type": "Standard_LRS",
"sizeGB": 30,
"utilizeEphemeralStorage": true
},
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"maxPods": 30
}
}
],
"count": 1,
"kind": "spotinst:ocean:azure:k8s:virtualNodeGroup"
}
}

Delete Virtual Node Group

Delete a specified virtual node group in an Ocean cluster.

Authorizations:

path Parameters

virtualNodeGroupId

required

string

Example: vng-12345abc

Ocean Virtual Node Group identifier.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/azure/k8s/virtualNodeGroup/vng-12345abc",
"method": "DELETE",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Launch VMs

Launch VMs in a Virtual Node Group.

Authorizations:

path Parameters

virtualNodeGroupId

required

string

Example: vng-12345abc

Ocean Virtual Node Group identifier.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

object (Ocean AKS Virtual Node Group Launch Request)

amount

required

integer

The number of VMs to launch.

Responses

Request samples

Payload

Content type

application/json

{"launchRequest": {"amount": 5
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/azure/k8s/virtualNodeGroup/vng-12345abc/launchVms",
"method": "PUT",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"vms": [{"vmName": "vm-001c1268d5bf",
"vmSize": "Standard_DS2_v2",
"lifeCycle": "spot"
}
]
}
],
"count": 1,
"kind": "spotinst:ocean:azure:k8s:virtualNodeGroup:launchVms"
}
}

Fetch Right Sizing Recommendations

Get right-sizing recommendations for an Ocean cluster and filter them according to namespace or label.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-12345abc

Identifier of the Ocean cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

object

Optional - may be null.

	object Optional - may be null.
namespaces	Array of strings Optional - may be null. If exists - should contain at least 1 item.

Responses

Request samples

Payload

Content type

application/json

{"filter": {"namespaces": ["sparkSpace",
"kube-system"
],
"attribute": {"type": "label",
"key": "app",
"operator": "Equals",
"value": "redis"
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/azure/k8s/cluster/o-abcd1234/rightSizing/suggestion",
"method": "POST",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"resourceName": "redis-controller",
"resourceType": "deployment",
"namespace": "kube-system",
"suggestedCPU": 4,
"suggestedMemory": 19,
"requestedCPU": 50,
"requestedMemory": 50,
"containers": [{"name": "dnsmasq",
"requestedCPU": 10,
"suggestedCPU": 2,
"requestedMemory": 40,
"suggestedMemory": 15
},
{"name": "sidecar",
"requestedCPU": 40,
"suggestedCPU": 2,
"requestedMemory": 10,
"suggestedMemory": 4
}
]
},
{"resourceName": "test-redis",
"resourceType": "deployment",
"namespace": "sparkSpace",
"suggestedCPU": 2,
"suggestedMemory": 20,
"requestedCPU": 50,
"requestedMemory": 30,
"containers": [{"name": "dns-controller",
"requestedCPU": 20,
"suggestedCPU": 1,
"requestedMemory": 20,
"suggestedMemory": 15
},
{"name": "kubedns",
"requestedCPU": 30,
"suggestedCPU": 1,
"requestedMemory": 10,
"suggestedMemory": 5
}
]
}
],
"count": 2,
"kind": "spotinst:ocean:azure:k8s:cluster:rightSizing:suggestion"
}
}

Ocean On-Premise

Ocean On-Premise API - Understand cost drivers within your on-premise clusters and compare the costs to the Ocean Cloud.

Ocean On-Premise - Create

Create a new Ocean On-Prem entity.

Prerequisites

The Ocean Controller is used to monitor the cluster resources and report back to Ocean and is required for Ocean On-Prem. To install the Ocean Controller, complete and run the following script on a machine with kubectl command line tool installed and configured:

  #!/usr/bin/env bash
  curl -fsSL http://spotinst-public.s3.amazonaws.com/integrations/kubernetes/cluster-controller/scripts/init.sh | \
  SPOTINST_TOKEN=<ENTER YOUR TOKEN HERE> \
  SPOTINST_ACCOUNT=<ENTER YOUR SPOTINST ACCOUNT ID HERE> \
  SPOTINST_CLUSTER_IDENTIFIER=<ENTER YOUR CLUSTER IDENTIFIER HERE> \
  bash

For more on the Ocean Controller and Ocean's anatomy see the documentation here.

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

required

object

controllerClusterIdentifier required	string The cluster Id where the Ocean controller is installed.
description	string Optionally provide a description.
name required	string The name of the cluster.
required	object (Price Per Unit) Ocean will monitor the costs of each resource unit.

Responses

Request samples

Payload

Content type

application/json

{"cluster": {"name": "oceanName",
"description": "Development",
"controllerClusterIdentifier": "k8sCluster",
"pricePerUnit": {"cpuHour": 0.015,
"memoryHour": 0.002
}
}
}

Response samples

Content type

application/json

{"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:ocean:onprem:k8s",
"items": {"id": "o-18887922",
"name": "oceanName",
"description": "development",
"controllerClusterIdentifier": "k8sCluster",
"pricePerUnit": {"cpuHour": 0.015,
"memoryHour": 0.002
},
"createdAt": "2018-11-26T09:39:52.933Z",
"updatedAt": "2018-11-26T09:39:52.933Z"
},
"count": 1
}
}

Ocean On-Premise - List

List the configurations for all Ocean cluster in the specified account.

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:ocean:onprem:k8s",
"items": {"id": "o-18887922",
"name": "oceanName",
"description": "development",
"controllerClusterIdentifier": "k8sCluster",
"pricePerUnit": {"cpuHour": 0.015,
"memoryHour": 0.002
},
"createdAt": "2018-11-26T09:39:52.933Z",
"updatedAt": "2018-11-26T09:39:52.933Z"
},
"count": 1
}
}

Delete Cluster

Delete an Ocean On-Prem cluster entity in Spot Ocean. This DOES NOT affect your on-prem cluster.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-abcd1234

Identifier of the Ocean cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Get Cluster

Get the configurations for the specified Ocean On-Prem cluster entity.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-abcd1234

Identifier of the Ocean cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:ocean:onprem:k8s",
"items": {"id": "o-18887922",
"name": "oceanName",
"description": "development",
"controllerClusterIdentifier": "k8sCluster",
"pricePerUnit": {"cpuHour": 0.015,
"memoryHour": 0.002
},
"createdAt": "2018-11-26T09:39:52.933Z",
"updatedAt": "2018-11-26T09:39:52.933Z"
},
"count": 1
}
}

Update Cluster

All Ocean on-prem parameters are updatable. This API supports partial updates, so specific fields can be updated separately.

Authorizations:

path Parameters

oceanClusterId

required

string

Example: o-abcd1234

Identifier of the Ocean cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

required	object (AWS Cluster)
group	object

Responses

Request samples

Payload

Content type

application/json

{"cluster": {"name": "oceanName",
"description": "Development",
"controllerClusterIdentifier": "k8sCluster",
"pricePerUnit": {"cpuHour": 0.015,
"memoryHour": 0.002
}
},
"group": { }
}

Response samples

Content type

application/json

{"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:ocean:onprem:k8s",
"items": {"id": "o-18887922",
"name": "oceanName",
"description": "development",
"controllerClusterIdentifier": "k8sCluster",
"pricePerUnit": {"cpuHour": 0.015,
"memoryHour": 0.002
},
"createdAt": "2018-11-26T09:39:52.933Z",
"updatedAt": "2018-11-26T09:39:52.933Z"
},
"count": 1
}
}

Ocean Insights

Insights allows Spot users on AWS to connect a Kubernetes cluster and within minutes get the cluster analyzed with insights about the current state of infrastructure in the cluster, and the potential effect of migrating the specific cluster into Ocean. Through its powerful features, Ocean presents significant opportunities for infrastructure optimization and automation, which are on display in the Insights console. Connected to Kubernetes clusters and running a continuous analysis, Ocean Insights delivers a holistic picture of your cluster and workloads behavior, from expected cloud costs and resource utilization. Through a simple UI, users will see a breakdown of potential savings when they first connect to Ocean Insights.

Ocean Insights

Create Cluster

Creates an Ocean Insight entity according to a given specification.

Prerequisite:

The Ocean Controller is used to monitor the cluster resources and report back to Ocean. The Ocean Controller is required for Ocean Insights.

To install the Ocean Controller, complete and run the following script on a machine with the kubectl command line tool installed and configured:

#!/usr/bin/env bash
curl -fsSL http://spotinst-public.s3.amazonaws.com/integrations/kubernetes/cluster-controller/scripts/init.sh | \
SPOTINST_TOKEN=<ENTER YOUR TOKEN HERE> \
SPOTINST_ACCOUNT=<ENTER YOUR SPOTINST ACCOUNT ID HERE> \
SPOTINST_CLUSTER_IDENTIFIER=<ENTER YOUR CLUSTER IDENTIFIER HERE> \
bash

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

required

object (Ocean Insight)

controllerClusterId required	string The reporting identifier for the Ocean Controller.
name required	string Add a name for the Ocean Insight cluster.

Responses

Request samples

Payload

Content type

application/json

{"cluster": {"name": "Ocean::my-ocean-insight-name",
"controllerClusterId": "oceanInsight.k8s"
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/insight/k8s/cluster",
"method": "POST",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "o-134abcd",
"name": "test",
"controllerClusterId": "test-123124",
"createdAt": "2021-03-17T08:13:08.000Z",
"updatedAt": "2021-03-17T15:06:13.000Z"
}
],
"count": 1,
"kind": "spotinst:ocean:insight:k8s"
}
}

List Clusters

Get the configurations for all Ocean Insights clusters in the specified account.

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/insight/k8s/cluster",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "o-134abcd",
"name": "test",
"controllerClusterId": "test-123124",
"createdAt": "2021-03-17T08:13:08.000Z",
"updatedAt": "2021-03-17T15:06:13.000Z"
}
],
"count": 1,
"kind": "spotinst:ocean:insight:k8s"
}
}

Get Cluster

Get the configurations for a specified Ocean Insight cluster.

Authorizations:

path Parameters

OCEAN_INSIGHT_ID

required

string

Example: oic-abcd1234

The ID of the Ocean Insight cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/insight/k8s/cluster/oic-12345abc",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "o-134abcd",
"name": "test",
"controllerClusterId": "test-123124",
"createdAt": "2021-03-17T08:13:08.000Z",
"updatedAt": "2021-03-17T15:06:13.000Z"
}
],
"count": 1,
"kind": "spotinst:ocean:insight:k8s"
}
}

Delete Cluster

Delete a specified Ocean Insight cluster.

Authorizations:

path Parameters

OCEAN_INSIGHT_ID

required

string

Example: oic-abcd1234

The ID of the Ocean Insight cluster.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/ocean/insight/k8s/cluster/oic-12345abc",
"method": "DELETE",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Ocean CD

Ocean CD is a fully managed continuous delivery ('CD') solution for Kubernetes applications. Designed for end-to-end automation and verification of frequent application-deployment processes at scale. Ocean CD architecture and API enable a simple and secured installation that seamlessly fits into any Kubernetes environment. Users get key features like granular visibility, SaaS logic that manage the rollout process, verifications of the applied workloads and automatic rollbacks. To enable Ocean CD, install the controller with one simple command in the Kubernetes cluster and create the following entities using the API:

Strategy
Rollout Spec

Ocean CD

List Ocean CD Clusters

List all Ocean CD clusters.

Authorizations:

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"lastHeartbeatTime": "2018-11-05T12:55:50.000+0000",
"controllerInfo": {"nodeName": "string",
"controllerVersion": "string",
"podName": "string"
},
"clusterInfo": {"kubernetesVersion": "string",
"cloudProvider": "string",
"kubernetesOrchestrator": "string"
},
"notification": {"minutesWithoutHeartbeat": 4,
"providers": ["provider1"
]
},
"id": "oceanCluster",
"createdAt": "2018-11-05T12:55:50.000+0000",
"updatedAt": "2018-11-05T12:58:15.000+0000"
}
]
}
}

Get Ocean CD Cluster

Get an existing Ocean CD cluster.

Authorizations:

path Parameters

clusterId

required

string

Example: cluster-prod

The identifier of the Ocean CD cluster

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"lastHeartbeatTime": "2018-11-05T12:55:50.000+0000",
"controllerInfo": {"nodeName": "string",
"controllerVersion": "string",
"podName": "string"
},
"clusterInfo": {"kubernetesVersion": "string",
"cloudProvider": "string",
"kubernetesOrchestrator": "string"
},
"notification": {"minutesWithoutHeartbeat": 4,
"providers": ["provider1"
]
},
"id": "oceanCluster",
"createdAt": "2018-11-05T12:55:50.000+0000",
"updatedAt": "2018-11-05T12:58:15.000+0000"
}
]
}
}

Update Ocean CD Cluster

Update Ocean CD cluster notification settings.

Authorizations:

path Parameters

clusterId

required

string

Example: cluster-prod

The identifier of the Ocean CD cluster

Request Body schema: application/json

object (oceanCDClusterNotification)

minutesWithoutHeartbeat	number Number of minutes without receiving cluster controller heartbeat
providers	Array of strings List of notification provider names

Responses

Request samples

Payload

Content type

application/json

{"notification": {"minutesWithoutHeartbeat": 4,
"providers": ["provider1"
]
}
}

Delete Ocean CD Cluster

Delete an existing Ocean CD cluster.

Authorizations:

path Parameters

clusterId

required

string

Example: cluster-prod

The identifier of the Ocean CD cluster

Responses

Create Ocean CD Verification Provider

Create Ocean CD Verification Provider. only one provider type can be defined

Authorizations:

Request Body schema: application/json

object (oceanCDVerificationProvider)

clusterIds required	Array of strings List of cluster ids that this Verification Provider will be applied to
	object (Ocean CD Verification Provider Datadog)
name required	string Identifier name for Ocean CD Verification Provider. Must be a unique name
	object (Ocean CD Verification Provider NewRelic)
	object (Ocean CD Verification Provider Prometheus)

Responses

Request samples

Payload

Content type

application/json

{"verificationProvider": {"name": "datadog-prod",
"clusterIds": ["prod-cluster-1",
"prod-cluster-2"
],
"prometheus": {"address": "string"
},
"datadog": {"address": "string",
"apiKey": "string",
"appKey": "string"
},
"newRelic": {"personalApiKey": "string",
"accountId": "string",
"region": "string",
"baseUrlRest": "string",
"baseUrlNerdGraph": "string"
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"name": "datadog-prod",
"clusterIds": ["prod-cluster-1",
"prod-cluster-2"
],
"prometheus": {"address": "string"
},
"datadog": {"address": "string",
"apiKey": "string",
"appKey": "string"
},
"newRelic": {"personalApiKey": "string",
"accountId": "string",
"region": "string",
"baseUrlRest": "string",
"baseUrlNerdGraph": "string"
},
"createdAt": "2018-11-05T12:55:50.000+0000",
"updatedAt": "2018-11-05T12:58:15.000+0000"
}
]
}
}

List Ocean CD Verification Providers

List all Ocean CD clusters.

Authorizations:

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"name": "datadog-prod",
"clusterIds": ["prod-cluster-1",
"prod-cluster-2"
],
"prometheus": {"address": "string"
},
"datadog": {"address": "string",
"apiKey": "string",
"appKey": "string"
},
"newRelic": {"personalApiKey": "string",
"accountId": "string",
"region": "string",
"baseUrlRest": "string",
"baseUrlNerdGraph": "string"
},
"createdAt": "2018-11-05T12:55:50.000+0000",
"updatedAt": "2018-11-05T12:58:15.000+0000"
}
]
}
}

Get Ocean CD Verification Provider

Get an existing Ocean CD Verification Provider.

Authorizations:

path Parameters

name

required

string

Example: datadog-prod

The identifier of the Ocean CD Verification Provider

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"name": "datadog-prod",
"clusterIds": ["prod-cluster-1",
"prod-cluster-2"
],
"prometheus": {"address": "string"
},
"datadog": {"address": "string",
"apiKey": "string",
"appKey": "string"
},
"newRelic": {"personalApiKey": "string",
"accountId": "string",
"region": "string",
"baseUrlRest": "string",
"baseUrlNerdGraph": "string"
},
"createdAt": "2018-11-05T12:55:50.000+0000",
"updatedAt": "2018-11-05T12:58:15.000+0000"
}
]
}
}

Update Ocean CD Verification Provider

Full Update of Ocean CD Verification Provider configuration. All non included fields will be nullified

Authorizations:

path Parameters

name

required

string

Example: datadog-prod

The identifier name of the Ocean CD Verification Provider

Request Body schema: application/json

object (oceanCDVerificationProviderUpdate)

clusterIds required	Array of strings List of cluster ids that this Verification Provider will be applied to
	object (Ocean CD Verification Provider Datadog)
	object (Ocean CD Verification Provider NewRelic)
	object (Ocean CD Verification Provider Prometheus)

Responses

Request samples

Payload

Content type

application/json

{"verificationProvider": {"clusterIds": ["prod-cluster-1",
"prod-cluster-2"
],
"prometheus": {"address": "string"
},
"datadog": {"address": "string",
"apiKey": "string",
"appKey": "string"
},
"newRelic": {"personalApiKey": "string",
"accountId": "string",
"region": "string",
"baseUrlRest": "string",
"baseUrlNerdGraph": "string"
}
}
}

Patch Ocean CD Verification Provider

Partial update Ocean CD Verification Provider configuration.

Authorizations:

path Parameters

name

required

string

Example: datadog-prod

The identifier name of the Ocean CD Verification Provider

Request Body schema: application/json

object (Ocean CD Verification Provider)

Ocean CD Verification Provider spec entity.

clusterIds	Array of strings List of cluster ids that this Verification Provider will be applied to
	object (Ocean CD Verification Provider Datadog)
	object (Ocean CD Verification Provider NewRelic)
	object (Ocean CD Verification Provider Prometheus)

Responses

Request samples

Payload

Content type

application/json

{"verificationProvider": {"clusterIds": ["prod-cluster-1",
"prod-cluster-2"
],
"prometheus": {"address": "string"
},
"datadog": {"address": "string",
"apiKey": "string",
"appKey": "string"
},
"newRelic": {"personalApiKey": "string",
"accountId": "string",
"region": "string",
"baseUrlRest": "string",
"baseUrlNerdGraph": "string"
}
}
}

Delete Ocean CD Verification Provider

Delete an existing Ocean CD Verification Provider.

Authorizations:

path Parameters

name

required

string

Example: datadog-prod

The identifier name of the Ocean CD Verification Provider

Responses

Create Ocean CD Verification Template

Create Ocean CD Verification Template.

Authorizations:

Request Body schema: application/json

object (oceanCDVerificationTemplate)

	Array of objects (Ocean CD Verification Template argument) [ items ] List of verification arguments
required	Array of objects (Ocean CD Verification Metric) [ items ] List of verification metrics
name required	string Identifier name for Ocean CD Verification Template. Must be a unique name

Responses

Request samples

Payload

Content type

application/json

{"verificationTemplate": {"name": "latency-validation",
"args": [{"name": "string",
"value": "string",
"valueFrom": {"podTemplateHashValue": "Stable",
"fieldRef": {"fieldPath": "metadata.labels['env']"
}
}
}
],
"metrics": [{"name": "string",
"interval": "5m",
"initialDelay": "1m",
"count": 10,
"successCondition": "result[0] <= 0.95",
"failureCondition": "result[0] >= 1.2",
"failureLimit": 0,
"inconclusiveLimit": 0,
"consecutiveErrorLimit": 0,
"provider": {"prometheus": {"query": "string"
},
"newRelic": {"profile": "string",
"query": "string"
},
"datadog": {"duration": "1m",
"query": "string"
},
"cloudWatch": {"duration": "1m",
"metricDataQueries": [{"id": "string",
"expression": "string",
"label": "string",
"metricStat": {"metric": {"dimensions": [{"name": "string",
"value": "string"
}
],
"metricName": "string",
"namespace": "string"
},
"expression": "string",
"period": 0,
"stat": "string",
"unit": "string"
},
"period": 0,
"returnData": true
}
]
},
"web": {"method": "string",
"url": "string",
"headers": [{"key": "string",
"value": "string"
}
],
"body": "string",
"timeoutSeconds": 0,
"jsonPath": "string",
"insecure": true
}
}
}
]
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"name": "latency-validation",
"args": [{"name": "string",
"value": "string",
"valueFrom": {"podTemplateHashValue": "Stable",
"fieldRef": {"fieldPath": "metadata.labels['env']"
}
}
}
],
"metrics": [{"name": "string",
"interval": "5m",
"initialDelay": "1m",
"count": 10,
"successCondition": "result[0] <= 0.95",
"failureCondition": "result[0] >= 1.2",
"failureLimit": 0,
"inconclusiveLimit": 0,
"consecutiveErrorLimit": 0,
"provider": {"prometheus": {"query": "string"
},
"newRelic": {"profile": "string",
"query": "string"
},
"datadog": {"duration": "1m",
"query": "string"
},
"cloudWatch": {"duration": "1m",
"metricDataQueries": [{"id": "string",
"expression": "string",
"label": "string",
"metricStat": {"metric": {"dimensions": [{"name": "string",
"value": "string"
}
],
"metricName": "string",
"namespace": "string"
},
"expression": "string",
"period": 0,
"stat": "string",
"unit": "string"
},
"period": 0,
"returnData": true
}
]
},
"web": {"method": "string",
"url": "string",
"headers": [{"key": "string",
"value": "string"
}
],
"body": "string",
"timeoutSeconds": 0,
"jsonPath": "string",
"insecure": true
}
}
}
],
"createdAt": "2018-11-05T12:55:50.000+0000",
"updatedAt": "2018-11-05T12:58:15.000+0000"
}
]
}
}

List Ocean CD Verification Templates

List all Ocean CD clusters.

Authorizations:

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"name": "latency-validation",
"args": [{"name": "string",
"value": "string",
"valueFrom": {"podTemplateHashValue": "Stable",
"fieldRef": {"fieldPath": "metadata.labels['env']"
}
}
}
],
"metrics": [{"name": "string",
"interval": "5m",
"initialDelay": "1m",
"count": 10,
"successCondition": "result[0] <= 0.95",
"failureCondition": "result[0] >= 1.2",
"failureLimit": 0,
"inconclusiveLimit": 0,
"consecutiveErrorLimit": 0,
"provider": {"prometheus": {"query": "string"
},
"newRelic": {"profile": "string",
"query": "string"
},
"datadog": {"duration": "1m",
"query": "string"
},
"cloudWatch": {"duration": "1m",
"metricDataQueries": [{"id": "string",
"expression": "string",
"label": "string",
"metricStat": {"metric": {"dimensions": [{"name": "string",
"value": "string"
}
],
"metricName": "string",
"namespace": "string"
},
"expression": "string",
"period": 0,
"stat": "string",
"unit": "string"
},
"period": 0,
"returnData": true
}
]
},
"web": {"method": "string",
"url": "string",
"headers": [{"key": "string",
"value": "string"
}
],
"body": "string",
"timeoutSeconds": 0,
"jsonPath": "string",
"insecure": true
}
}
}
],
"createdAt": "2018-11-05T12:55:50.000+0000",
"updatedAt": "2018-11-05T12:58:15.000+0000"
}
]
}
}

Get Ocean CD Verification Template

Get an existing Ocean CD Verification Template.

Authorizations:

path Parameters

name

required

string

Example: latency-validation

The identifier of the Ocean CD Verification Template

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"name": "latency-validation",
"args": [{"name": "string",
"value": "string",
"valueFrom": {"podTemplateHashValue": "Stable",
"fieldRef": {"fieldPath": "metadata.labels['env']"
}
}
}
],
"metrics": [{"name": "string",
"interval": "5m",
"initialDelay": "1m",
"count": 10,
"successCondition": "result[0] <= 0.95",
"failureCondition": "result[0] >= 1.2",
"failureLimit": 0,
"inconclusiveLimit": 0,
"consecutiveErrorLimit": 0,
"provider": {"prometheus": {"query": "string"
},
"newRelic": {"profile": "string",
"query": "string"
},
"datadog": {"duration": "1m",
"query": "string"
},
"cloudWatch": {"duration": "1m",
"metricDataQueries": [{"id": "string",
"expression": "string",
"label": "string",
"metricStat": {"metric": {"dimensions": [{"name": "string",
"value": "string"
}
],
"metricName": "string",
"namespace": "string"
},
"expression": "string",
"period": 0,
"stat": "string",
"unit": "string"
},
"period": 0,
"returnData": true
}
]
},
"web": {"method": "string",
"url": "string",
"headers": [{"key": "string",
"value": "string"
}
],
"body": "string",
"timeoutSeconds": 0,
"jsonPath": "string",
"insecure": true
}
}
}
],
"createdAt": "2018-11-05T12:55:50.000+0000",
"updatedAt": "2018-11-05T12:58:15.000+0000"
}
]
}
}

Update Ocean CD Verification Template

Full Update of Ocean CD Verification Template configuration. All non included fields will be nullified

Authorizations:

path Parameters

name

required

string

Example: latency-validation

The identifier name of the Ocean CD Verification Template

Request Body schema: application/json

object (oceanCDVerificationTemplateUpdate)

	Array of objects (Ocean CD Verification Template argument) [ items ] List of verification arguments
required	Array of objects (Ocean CD Verification Metric) [ items ] List of verification metrics

Responses

Request samples

Payload

Content type

application/json

{"verificationTemplate": {"args": [{"name": "string",
"value": "string",
"valueFrom": {"podTemplateHashValue": "Stable",
"fieldRef": {"fieldPath": "metadata.labels['env']"
}
}
}
],
"metrics": [{"name": "string",
"interval": "5m",
"initialDelay": "1m",
"count": 10,
"successCondition": "result[0] <= 0.95",
"failureCondition": "result[0] >= 1.2",
"failureLimit": 0,
"inconclusiveLimit": 0,
"consecutiveErrorLimit": 0,
"provider": {"prometheus": {"query": "string"
},
"newRelic": {"profile": "string",
"query": "string"
},
"datadog": {"duration": "1m",
"query": "string"
},
"cloudWatch": {"duration": "1m",
"metricDataQueries": [{"id": "string",
"expression": "string",
"label": "string",
"metricStat": {"metric": {"dimensions": [{"name": "string",
"value": "string"
}
],
"metricName": "string",
"namespace": "string"
},
"expression": "string",
"period": 0,
"stat": "string",
"unit": "string"
},
"period": 0,
"returnData": true
}
]
},
"web": {"method": "string",
"url": "string",
"headers": [{"key": "string",
"value": "string"
}
],
"body": "string",
"timeoutSeconds": 0,
"jsonPath": "string",
"insecure": true
}
}
}
]
}
}

Patch Ocean CD Verification Template

Partial update Ocean CD Verification Template configuration.

Authorizations:

path Parameters

name

required

string

Example: latency-validation

The identifier name of the Ocean CD Verification Template

Request Body schema: application/json

object (Ocean CD Verification Template)

Ocean CD Verification Template spec entity.

	Array of objects (Ocean CD Verification Template argument) [ items ] List of verification arguments
	Array of objects (Ocean CD Verification Metric) [ items ] List of verification metrics

Responses

Request samples

Payload

Content type

application/json

{"verificationTemplate": {"args": [{"name": "string",
"value": "string",
"valueFrom": {"podTemplateHashValue": "Stable",
"fieldRef": {"fieldPath": "metadata.labels['env']"
}
}
}
],
"metrics": [{"name": "string",
"interval": "5m",
"initialDelay": "1m",
"count": 10,
"successCondition": "result[0] <= 0.95",
"failureCondition": "result[0] >= 1.2",
"failureLimit": 0,
"inconclusiveLimit": 0,
"consecutiveErrorLimit": 0,
"provider": {"prometheus": {"query": "string"
},
"newRelic": {"profile": "string",
"query": "string"
},
"datadog": {"duration": "1m",
"query": "string"
},
"cloudWatch": {"duration": "1m",
"metricDataQueries": [{"id": "string",
"expression": "string",
"label": "string",
"metricStat": {"metric": {"dimensions": [{"name": "string",
"value": "string"
}
],
"metricName": "string",
"namespace": "string"
},
"expression": "string",
"period": 0,
"stat": "string",
"unit": "string"
},
"period": 0,
"returnData": true
}
]
},
"web": {"method": "string",
"url": "string",
"headers": [{"key": "string",
"value": "string"
}
],
"body": "string",
"timeoutSeconds": 0,
"jsonPath": "string",
"insecure": true
}
}
}
]
}
}

Delete Ocean CD Verification Template

Delete an existing Ocean CD Verification Template.

Authorizations:

path Parameters

name

required

string

Example: latency-validation

The identifier name of the Ocean CD Verification Template

Responses

Create Ocean CD Strategy

Create Ocean CD Strategy.

Authorizations:

Request Body schema: application/json

object (Ocean CD Strategy)

Ocean CD strategy. Use in RolloutSpec to decide what strategy to use when applying SpotDeployment

required	object (Ocean CD Strategy Canary) Represents Canary strategy
name required	string Identifier name for Ocean CD Strategy. Must be a unique name

Responses

Request samples

Payload

Content type

application/json

{"strategy": {"name": "service-strategy",
"canary": {"backgroundVerification": {"templateNames": ["verification-template-name"
],
"args": [{"name": "app",
"value": "service",
"valueFrom": {"secretRef": {"name": "app-name",
"key": "app"
},
"filedRef": {"fieldPath": "metadata.labels['app']"
}
}
}
]
},
"steps": [{"name": "first-step",
"setWeight": 20,
"setCanaryScale": {"weight": 20,
"replicas": 20,
"matchTrafficWeight": true
},
"verification": {"templateNames": ["verification-template-name"
],
"args": [{"name": "app",
"value": "service",
"valueFrom": {"secretRef": {"name": "app-name",
"key": "app"
},
"filedRef": {"fieldPath": "metadata.labels['app']"
}
}
}
]
},
"pause": {"duration": "5m"
}
}
]
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"name": "service-strategy",
"canary": {"backgroundVerification": {"templateNames": ["verification-template-name"
],
"args": [{"name": "app",
"value": "service",
"valueFrom": {"secretRef": {"name": "app-name",
"key": "app"
},
"filedRef": {"fieldPath": "metadata.labels['app']"
}
}
}
]
},
"steps": [{"name": "first-step",
"setWeight": 20,
"setCanaryScale": {"weight": 20,
"replicas": 20,
"matchTrafficWeight": true
},
"verification": {"templateNames": ["verification-template-name"
],
"args": [{"name": "app",
"value": "service",
"valueFrom": {"secretRef": {"name": "app-name",
"key": "app"
},
"filedRef": {"fieldPath": "metadata.labels['app']"
}
}
}
]
},
"pause": {"duration": "5m"
}
}
]
},
"createdAt": "2018-11-05T12:55:50.000+0000",
"updatedAt": "2018-11-05T12:58:15.000+0000"
}
]
}
}

List Ocean CD Strategies

List all Ocean CD strategies.

Authorizations:

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"name": "service-strategy",
"canary": {"backgroundVerification": {"templateNames": ["verification-template-name"
],
"args": [{"name": "app",
"value": "service",
"valueFrom": {"secretRef": {"name": "app-name",
"key": "app"
},
"filedRef": {"fieldPath": "metadata.labels['app']"
}
}
}
]
},
"steps": [{"name": "first-step",
"setWeight": 20,
"setCanaryScale": {"weight": 20,
"replicas": 20,
"matchTrafficWeight": true
},
"verification": {"templateNames": ["verification-template-name"
],
"args": [{"name": "app",
"value": "service",
"valueFrom": {"secretRef": {"name": "app-name",
"key": "app"
},
"filedRef": {"fieldPath": "metadata.labels['app']"
}
}
}
]
},
"pause": {"duration": "5m"
}
}
]
},
"createdAt": "2018-11-05T12:55:50.000+0000",
"updatedAt": "2018-11-05T12:58:15.000+0000"
}
]
}
}

Get Ocean CD Strategy

Get an existing Ocean CD Strategy.

Authorizations:

path Parameters

strategyName

required

string

Example: canary-prod

The identifier name of the Ocean CD Strategy

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"name": "service-strategy",
"canary": {"backgroundVerification": {"templateNames": ["verification-template-name"
],
"args": [{"name": "app",
"value": "service",
"valueFrom": {"secretRef": {"name": "app-name",
"key": "app"
},
"filedRef": {"fieldPath": "metadata.labels['app']"
}
}
}
]
},
"steps": [{"name": "first-step",
"setWeight": 20,
"setCanaryScale": {"weight": 20,
"replicas": 20,
"matchTrafficWeight": true
},
"verification": {"templateNames": ["verification-template-name"
],
"args": [{"name": "app",
"value": "service",
"valueFrom": {"secretRef": {"name": "app-name",
"key": "app"
},
"filedRef": {"fieldPath": "metadata.labels['app']"
}
}
}
]
},
"pause": {"duration": "5m"
}
}
]
},
"createdAt": "2018-11-05T12:55:50.000+0000",
"updatedAt": "2018-11-05T12:58:15.000+0000"
}
]
}
}

Update Ocean CD Strategy

Full Update of Ocean CD strategy configuration. All non included fields will be nullified

Authorizations:

path Parameters

strategyName

required

string

Example: canary-prod

The identifier name of the Ocean CD Strategy

Request Body schema: application/json

object (Ocean CD Strategy)

Ocean CD strategy. Use in RolloutSpec to decide what strategy to use when applying SpotDeployment

required

object (Ocean CD Strategy Canary)

Represents Canary strategy

	object (Ocean CD Strategy Background Verification) Represents list of background verification to run
required	Array of objects (Ocean CD Strategy Canary) [ items ]

Responses

Request samples

Payload

Content type

application/json

{"strategy": {"canary": {"backgroundVerification": {"templateNames": ["verification-template-name"
],
"args": [{"name": "app",
"value": "service",
"valueFrom": {"secretRef": {"name": "app-name",
"key": "app"
},
"filedRef": {"fieldPath": "metadata.labels['app']"
}
}
}
]
},
"steps": [{"name": "first-step",
"setWeight": 20,
"setCanaryScale": {"weight": 20,
"replicas": 20,
"matchTrafficWeight": true
},
"verification": {"templateNames": ["verification-template-name"
],
"args": [{"name": "app",
"value": "service",
"valueFrom": {"secretRef": {"name": "app-name",
"key": "app"
},
"filedRef": {"fieldPath": "metadata.labels['app']"
}
}
}
]
},
"pause": {"duration": "5m"
}
}
]
}
}
}

Patch Ocean CD Strategy

Partial update Ocean CD strategy configuration.

Authorizations:

path Parameters

strategyName

required

string

Example: canary-prod

The identifier name of the Ocean CD Strategy

Request Body schema: application/json

object (Ocean CD Strategy)

Ocean CD strategy. Use in RolloutSpec to decide what strategy to use when applying SpotDeployment

required

object (Ocean CD Strategy Canary)

Represents Canary strategy

	object (Ocean CD Strategy Background Verification) Represents list of background verification to run
required	Array of objects (Ocean CD Strategy Canary) [ items ]

Responses

Request samples

Payload

Content type

application/json

{"strategy": {"canary": {"backgroundVerification": {"templateNames": ["verification-template-name"
],
"args": [{"name": "app",
"value": "service",
"valueFrom": {"secretRef": {"name": "app-name",
"key": "app"
},
"filedRef": {"fieldPath": "metadata.labels['app']"
}
}
}
]
},
"steps": [{"name": "first-step",
"setWeight": 20,
"setCanaryScale": {"weight": 20,
"replicas": 20,
"matchTrafficWeight": true
},
"verification": {"templateNames": ["verification-template-name"
],
"args": [{"name": "app",
"value": "service",
"valueFrom": {"secretRef": {"name": "app-name",
"key": "app"
},
"filedRef": {"fieldPath": "metadata.labels['app']"
}
}
}
]
},
"pause": {"duration": "5m"
}
}
]
}
}
}

Delete Ocean CD Strategy

Delete an existing Ocean CD strategy.

Authorizations:

path Parameters

strategyName

required

string

Example: canary-prod

The identifier name of the Ocean CD Strategy

Responses

Create Ocean CD Rollout Spec

Create Ocean CD rollout spec.

Authorizations:

Request Body schema: application/json

object (Ocean CD Rollout Spec)

Ocean CD rollout spec entity.

	object (Ocean CD Rollout Spec Failure Policy) Holds information on how to react when failure happens
name required	string Identifier name for Ocean CD Rollout Spec. Must be a unique name
required	object (Ocean CD Spot Deployment Selector) Used to match the rolloutspec to a `SpotDeployment` resource
required	object (Ocean CD Rollout Spec Strategy) Determines the rollout spec strategy.
required	object (Ocean CD Rollout Spec Traffic) hosts all the supported service meshes supported to enable more fine-grained traffic routing

Responses

Request samples

Payload

Content type

application/json

{"rolloutSpec": {"name": "service-rolloutspec",
"spotDeployment": {"clusterId": "string",
"namespace": "string",
"name": "string"
},
"strategy": {"name": "service-rolloutspec",
"args": [{"name": "app",
"value": "service",
"valueFrom": {"secretRef": {"name": "app-name",
"key": "app"
},
"filedRef": {"fieldPath": "metadata.labels['app']"
}
}
}
]
},
"traffic": {"canaryService": "canary",
"stableService": "stable",
"istio": {"virtualServices": [{"name": "service",
"routes": ["http-primary"
],
"tlsRoutes": [{"port": 443,
"sniHosts": ["spot.io"
]
}
]
}
],
"destinationRule": {"name": "string",
"canarySubsetName": "string",
"stableSubsetName": "string"
}
},
"nginx": {"annotationPrefix": "string",
"stableIngress": "string",
"additionalIngressAnnotations": {"property1": "string",
"property2": "string"
}
},
"alb": {"ingress": "string",
"servicePort": 0,
"rootService": "string",
"stickinessConfig": {"enabled": true,
"durationSeconds": 0
},
"annotationPrefix": "string"
},
"smi": {"rootService": "string",
"trafficSplitName": "string"
},
"ambassador": {"mappings": ["stable-mapping"
]
},
"appMesh": {"virtualService": {"name": "string",
"routes": ["string"
]
},
"virtualNodeGroup": {"canaryVirtualNodeRef": {"name": "string"
},
"stableVirtualNodeRef": {"name": "string"
}
}
},
"pingPong": {"pingService": "string",
"pongService": "string"
}
},
"failurePolicy": {"action": "abort"
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"name": "service-rolloutspec",
"spotDeployment": {"clusterId": "string",
"namespace": "string",
"name": "string"
},
"strategy": {"name": "service-rolloutspec",
"args": [{"name": "app",
"value": "service",
"valueFrom": {"secretRef": {"name": "app-name",
"key": "app"
},
"filedRef": {"fieldPath": "metadata.labels['app']"
}
}
}
]
},
"traffic": {"canaryService": "canary",
"stableService": "stable",
"istio": {"virtualServices": [{"name": "service",
"routes": ["http-primary"
],
"tlsRoutes": [{"port": 443,
"sniHosts": ["spot.io"
]
}
]
}
],
"destinationRule": {"name": "string",
"canarySubsetName": "string",
"stableSubsetName": "string"
}
},
"nginx": {"annotationPrefix": "string",
"stableIngress": "string",
"additionalIngressAnnotations": {"property1": "string",
"property2": "string"
}
},
"alb": {"ingress": "string",
"servicePort": 0,
"rootService": "string",
"stickinessConfig": {"enabled": true,
"durationSeconds": 0
},
"annotationPrefix": "string"
},
"smi": {"rootService": "string",
"trafficSplitName": "string"
},
"ambassador": {"mappings": ["stable-mapping"
]
},
"appMesh": {"virtualService": {"name": "string",
"routes": ["string"
]
},
"virtualNodeGroup": {"canaryVirtualNodeRef": {"name": "string"
},
"stableVirtualNodeRef": {"name": "string"
}
}
},
"pingPong": {"pingService": "string",
"pongService": "string"
}
},
"failurePolicy": {"action": "abort"
},
"createdAt": "2018-11-05T12:55:50.000+0000",
"updatedAt": "2018-11-05T12:58:15.000+0000"
}
]
}
}

List Ocean CD Rollout Specs

List all Ocean CD rollout specs.

Authorizations:

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"name": "service-rolloutspec",
"spotDeployment": {"clusterId": "string",
"namespace": "string",
"name": "string"
},
"strategy": {"name": "service-rolloutspec",
"args": [{"name": "app",
"value": "service",
"valueFrom": {"secretRef": {"name": "app-name",
"key": "app"
},
"filedRef": {"fieldPath": "metadata.labels['app']"
}
}
}
]
},
"traffic": {"canaryService": "canary",
"stableService": "stable",
"istio": {"virtualServices": [{"name": "service",
"routes": ["http-primary"
],
"tlsRoutes": [{"port": 443,
"sniHosts": ["spot.io"
]
}
]
}
],
"destinationRule": {"name": "string",
"canarySubsetName": "string",
"stableSubsetName": "string"
}
},
"nginx": {"annotationPrefix": "string",
"stableIngress": "string",
"additionalIngressAnnotations": {"property1": "string",
"property2": "string"
}
},
"alb": {"ingress": "string",
"servicePort": 0,
"rootService": "string",
"stickinessConfig": {"enabled": true,
"durationSeconds": 0
},
"annotationPrefix": "string"
},
"smi": {"rootService": "string",
"trafficSplitName": "string"
},
"ambassador": {"mappings": ["stable-mapping"
]
},
"appMesh": {"virtualService": {"name": "string",
"routes": ["string"
]
},
"virtualNodeGroup": {"canaryVirtualNodeRef": {"name": "string"
},
"stableVirtualNodeRef": {"name": "string"
}
}
},
"pingPong": {"pingService": "string",
"pongService": "string"
}
},
"failurePolicy": {"action": "abort"
},
"createdAt": "2018-11-05T12:55:50.000+0000",
"updatedAt": "2018-11-05T12:58:15.000+0000"
}
]
}
}

Get Ocean CD Rollout Spec

Get the configuration of an existing Ocean CD rollout spec.

Authorizations:

path Parameters

rolloutSpecName

required

string

Example: app-rolloutspec

The identifier name of the Ocean CD Rollout Spec

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"name": "service-rolloutspec",
"spotDeployment": {"clusterId": "string",
"namespace": "string",
"name": "string"
},
"strategy": {"name": "service-rolloutspec",
"args": [{"name": "app",
"value": "service",
"valueFrom": {"secretRef": {"name": "app-name",
"key": "app"
},
"filedRef": {"fieldPath": "metadata.labels['app']"
}
}
}
]
},
"traffic": {"canaryService": "canary",
"stableService": "stable",
"istio": {"virtualServices": [{"name": "service",
"routes": ["http-primary"
],
"tlsRoutes": [{"port": 443,
"sniHosts": ["spot.io"
]
}
]
}
],
"destinationRule": {"name": "string",
"canarySubsetName": "string",
"stableSubsetName": "string"
}
},
"nginx": {"annotationPrefix": "string",
"stableIngress": "string",
"additionalIngressAnnotations": {"property1": "string",
"property2": "string"
}
},
"alb": {"ingress": "string",
"servicePort": 0,
"rootService": "string",
"stickinessConfig": {"enabled": true,
"durationSeconds": 0
},
"annotationPrefix": "string"
},
"smi": {"rootService": "string",
"trafficSplitName": "string"
},
"ambassador": {"mappings": ["stable-mapping"
]
},
"appMesh": {"virtualService": {"name": "string",
"routes": ["string"
]
},
"virtualNodeGroup": {"canaryVirtualNodeRef": {"name": "string"
},
"stableVirtualNodeRef": {"name": "string"
}
}
},
"pingPong": {"pingService": "string",
"pongService": "string"
}
},
"failurePolicy": {"action": "abort"
},
"createdAt": "2018-11-05T12:55:50.000+0000",
"updatedAt": "2018-11-05T12:58:15.000+0000"
}
]
}
}

Update Ocean CD Rollout Spec

Full Update Ocean CD rollout spec configuration. All non included fields will be nullified

Authorizations:

path Parameters

rolloutSpecName

required

string

Example: app-rolloutspec

The identifier name of the Ocean CD Rollout Spec

Request Body schema: application/json

object (Ocean CD Rollout Spec)

Ocean CD rollout spec entity.

	object (Ocean CD Rollout Spec Failure Policy) Holds information on how to react when failure happens
required	object (Ocean CD Spot Deployment Selector) Used to match the rolloutspec to a `SpotDeployment` resource
required	object (Ocean CD Rollout Spec Strategy) Determines the rollout spec strategy.
required	object (Ocean CD Rollout Spec Traffic) hosts all the supported service meshes supported to enable more fine-grained traffic routing

Responses

Request samples

Payload

Content type

application/json

{"rolloutSpec": {"spotDeployment": {"clusterId": "string",
"namespace": "string",
"name": "string"
},
"strategy": {"name": "service-rolloutspec",
"args": [{"name": "app",
"value": "service",
"valueFrom": {"secretRef": {"name": "app-name",
"key": "app"
},
"filedRef": {"fieldPath": "metadata.labels['app']"
}
}
}
]
},
"traffic": {"canaryService": "canary",
"stableService": "stable",
"istio": {"virtualServices": [{"name": "service",
"routes": ["http-primary"
],
"tlsRoutes": [{"port": 443,
"sniHosts": ["spot.io"
]
}
]
}
],
"destinationRule": {"name": "string",
"canarySubsetName": "string",
"stableSubsetName": "string"
}
},
"nginx": {"annotationPrefix": "string",
"stableIngress": "string",
"additionalIngressAnnotations": {"property1": "string",
"property2": "string"
}
},
"alb": {"ingress": "string",
"servicePort": 0,
"rootService": "string",
"stickinessConfig": {"enabled": true,
"durationSeconds": 0
},
"annotationPrefix": "string"
},
"smi": {"rootService": "string",
"trafficSplitName": "string"
},
"ambassador": {"mappings": ["stable-mapping"
]
},
"appMesh": {"virtualService": {"name": "string",
"routes": ["string"
]
},
"virtualNodeGroup": {"canaryVirtualNodeRef": {"name": "string"
},
"stableVirtualNodeRef": {"name": "string"
}
}
},
"pingPong": {"pingService": "string",
"pongService": "string"
}
},
"failurePolicy": {"action": "abort"
}
}
}

Patch Ocean CD Rollout Spec

Partial update Ocean CD rollout spec configuration.

Authorizations:

path Parameters

rolloutSpecName

required

string

Example: app-rolloutspec

The identifier name of the Ocean CD Rollout Spec

Request Body schema: application/json

object (Ocean CD Rollout Spec)

Ocean CD rollout spec entity.

	object (Ocean CD Rollout Spec Failure Policy) Holds information on how to react when failure happens
	object (Ocean CD Spot Deployment Selector) Used to match the rolloutspec to a `SpotDeployment` resource
	object (Ocean CD Rollout Spec Strategy) Determines the rollout spec strategy.
	object (Ocean CD Rollout Spec Traffic) hosts all the supported service meshes supported to enable more fine-grained traffic routing

Responses

Request samples

Payload

Content type

application/json

{"rolloutSpec": {"spotDeployment": {"clusterId": "string",
"namespace": "string",
"name": "string"
},
"strategy": {"name": "service-rolloutspec",
"args": [{"name": "app",
"value": "service",
"valueFrom": {"secretRef": {"name": "app-name",
"key": "app"
},
"filedRef": {"fieldPath": "metadata.labels['app']"
}
}
}
]
},
"traffic": {"canaryService": "canary",
"stableService": "stable",
"istio": {"virtualServices": [{"name": "service",
"routes": ["http-primary"
],
"tlsRoutes": [{"port": 443,
"sniHosts": ["spot.io"
]
}
]
}
],
"destinationRule": {"name": "string",
"canarySubsetName": "string",
"stableSubsetName": "string"
}
},
"nginx": {"annotationPrefix": "string",
"stableIngress": "string",
"additionalIngressAnnotations": {"property1": "string",
"property2": "string"
}
},
"alb": {"ingress": "string",
"servicePort": 0,
"rootService": "string",
"stickinessConfig": {"enabled": true,
"durationSeconds": 0
},
"annotationPrefix": "string"
},
"smi": {"rootService": "string",
"trafficSplitName": "string"
},
"ambassador": {"mappings": ["stable-mapping"
]
},
"appMesh": {"virtualService": {"name": "string",
"routes": ["string"
]
},
"virtualNodeGroup": {"canaryVirtualNodeRef": {"name": "string"
},
"stableVirtualNodeRef": {"name": "string"
}
}
},
"pingPong": {"pingService": "string",
"pongService": "string"
}
},
"failurePolicy": {"action": "abort"
}
}
}

Delete Ocean CD Rollout Spec

Delete an existing Ocean CD rollout spec.

Authorizations:

path Parameters

rolloutSpecName

required

string

Example: app-rolloutspec

The identifier name of the Ocean CD Rollout Spec

Responses

Ocean CD Rollout Actions

Execute action on an existing Ocean CD rollout.

Authorizations:

path Parameters

rolloutId

required

string

Example: rol-123456

The identifier of the Ocean CD rollout

Request Body schema: application/json

action

required

string

Enum: "promote" "promoteFull" "pause" "abort" "retry"

Responses

Request samples

Payload

Content type

application/json

{"action": "promote"
}

Ocean Spark

Ocean for Apache Spark is a managed cloud-native Spark platform that can be deployed in your cloud account.

Running on top of Ocean, Spot’s serverless infrastructure engine for containers, Ocean Spark makes it easy for your data teams to be successful with Apache Spark on Kubernetes, without dealing with the complexity of managing servers.

Ocean Spark

List Clusters

List the Ocean Spark clusters in the specified account.

Authorizations:

query Parameters

accountId	string Example: accountId=act-123456789 The ID of the account associated with your token. If omitted the oldest account in the organization will be used.
controllerClusterId	string (controllerClusterId) Example: controllerClusterId=my-ocean-cluster Optionally filter on the reporting identifier of the Ocean controller in the Ocean cluster (controllerClusterId)
	unix (string) or dateTime (string) Example: fromDate=2020-09-01 or fromDate=1598918400000 Get items on or after this date (ISO 8601 or Unix timestamp)
state	any (oceanSparkClusterState) Enum: "AVAILABLE" "PROGRESSING" "DEGRADED" "FAILING" "UNKNOWN" "UNREACHABLE" "DELETING" Example: state=AVAILABLE Optionally filter on the current state of the Ocean Spark cluster
	unix (string) or dateTime (string) Example: toDate=2020-09-01 or toDate=1598918400000 Get items on or before this date (ISO 8601 or Unix timestamp)

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-11-01T10:50:29.000+0000",
"id": "osc-20fac3f1",
"controllerClusterId": "my-ocean-cluster",
"oceanClusterId": "o-d3a2908e",
"state": "AVAILABLE",
"region": "us-west-2",
"k8sVersion": "v1.21.2-eks-0389ca3",
"nodeCount": 1,
"runningAppCount": 3,
"oceanControllerLastHeartbeat": "2021-11-20T13:29:53.000Z",
"operatorLastHeartbeat": "2021-11-20T13:29:30.000Z"
}
],
"count": 1,
"kind": "string"
}
}

Get Cluster

Describe an Ocean Spark cluster.

Authorizations:

path Parameters

clusterId

required

string (oceanSparkClusterId)

Example: osc-20fac3f1

A unique identifier for the Ocean Spark cluster

query Parameters

accountId

string

Example: accountId=act-123456789

The ID of the account associated with your token. If omitted the oldest account in the organization will be used.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-11-01T10:50:29.000+0000",
"id": "osc-20fac3f1",
"controllerClusterId": "my-ocean-cluster",
"oceanClusterId": "o-d3a2908e",
"state": "AVAILABLE",
"region": "us-west-2",
"k8sVersion": "v1.21.2-eks-0389ca3",
"nodeCount": 1,
"runningAppCount": 3,
"oceanControllerLastHeartbeat": "2021-11-20T13:29:53.000Z",
"operatorLastHeartbeat": "2021-11-20T13:29:30.000Z"
}
],
"count": 1,
"kind": "string"
}
}

Delete Cluster

Delete an Ocean Spark cluster.

Removing a cluster will disconnect it from Ocean for Spark. This action is permanent and cannot be undone.

The Ocean for Spark resources will be uninstalled from the cluster, but the Ocean cluster itself (and related Kubernetes resources) will not be deleted.

Authorizations:

path Parameters

clusterId

required

string (oceanSparkClusterId)

Example: osc-20fac3f1

A unique identifier for the Ocean Spark cluster

query Parameters

accountId

string

Example: accountId=act-123456789

The ID of the account associated with your token. If omitted the oldest account in the organization will be used.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-11-01T10:50:29.000+0000",
"id": "osc-20fac3f1",
"controllerClusterId": "my-ocean-cluster",
"oceanClusterId": "o-d3a2908e",
"state": "AVAILABLE",
"region": "us-west-2",
"k8sVersion": "v1.21.2-eks-0389ca3",
"nodeCount": 1,
"runningAppCount": 3,
"oceanControllerLastHeartbeat": "2021-11-20T13:29:53.000Z",
"operatorLastHeartbeat": "2021-11-20T13:29:30.000Z"
}
],
"count": 1,
"kind": "string"
}
}

Cluster application completion trend

Aggregates the number of apps reaching a terminal state (completed, failed, killed, ...) within time buckets.

Authorizations:

path Parameters

clusterId

required

string (oceanSparkClusterId)

Example: osc-20fac3f1

A unique identifier for the Ocean Spark cluster

query Parameters

accountId	string Example: accountId=act-123456789 The ID of the account associated with your token. If omitted the oldest account in the organization will be used.
since required	string <date-time> Example: since=2021-11-22 Date at which to start the analysis. If the time range up to now is less or equal to a day, values are reported grouped per hours. Otherwise, values are reported grouped per days.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"start": "2021-11-18T17:09:37+00:00",
"end": "2021-11-18T17:09:37+00:00",
"completed": "2021-11-18T17:09:37+00:00",
"failed": 0,
"killed": 0,
"timed_out": 0
}
],
"count": 1,
"kind": "string"
}
}

Cluster application load history

Reports the number of applications in pending and running state within time buckets.

Authorizations:

path Parameters

clusterId

required

string (oceanSparkClusterId)

Example: osc-20fac3f1

A unique identifier for the Ocean Spark cluster

query Parameters

accountId	string Example: accountId=act-123456789 The ID of the account associated with your token. If omitted the oldest account in the organization will be used.
since required	string <date-time> Example: since=2021-11-22 Date at which to start the analysis. If the time range up to now is less or equal to a day, values are reported grouped per hours. Otherwise, values are reported grouped per days.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"time": "2021-11-18T17:09:37+00:00",
"pending": 0,
"running": 0
}
],
"count": 1,
"kind": "string"
}
}

Cluster runtime statistics

Returns a summary of the cluster usage since a given date in the past.

Authorizations:

path Parameters

clusterId

required

string (oceanSparkClusterId)

Example: osc-20fac3f1

A unique identifier for the Ocean Spark cluster

query Parameters

accountId	string Example: accountId=act-123456789 The ID of the account associated with your token. If omitted the oldest account in the organization will be used.
since required	string <date-time> Example: since=2021-11-22 Date at which to start the analysis. If the time range up to now is less or equal to a day, values are reported grouped per hours. Otherwise, values are reported grouped per days.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "osc-20fac3f1",
"metrics": {"cost": {"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-10-10T10:50:29.000+0000",
"total": 0
},
"spark": {"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-10-10T10:50:29.000+0000",
"sparkCoresDurationSeconds": 0,
"inputDataBytes": 0,
"outputDataBytes": 0,
"durationSeconds": 0,
"efficiencyPercent": 0
}
}
}
],
"count": 1,
"kind": "string"
}
}

List Applications

List Spark applications on all Ocean Spark clusters in the specified account. This endpoint is paginated (cursor pagination).

Authorizations:

query Parameters

accountId	string Example: accountId=act-123456789 The ID of the account associated with your token. If omitted the oldest account in the organization will be used.
after	string (after) Example: after=MjAyMS0xMS0xOFQwOTo1MjowNS43Mzg4NjArMDA6MDB8NWM3NGY2MDYtZDYxNy00MzcxLWE5ZDktNjc2ZDkxMzRlNWFk If specified, the page returned in the response contains the items right after this cursor in the ordering
before	string (before) Example: before=MjAyMS0xMS0xOFQwOTo1MjowNS43Mzg4NjArMDA6MDB8NWM3NGY2MDYtZDYxNy00MzcxLWE5ZDktNjc2ZDkxMzRlNWFk If specified, the page returned in the response contains the items right before this cursor in the ordering
clusterId	string (oceanSparkClusterId) Example: clusterId=osc-20fac3f1 Optionally filter on the Ocean Spark cluster ID
jobId	string (oceanSparkJobId) ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a... Example: jobId=daily-reporting Optionally filter on the job ID
maxCreatedAt	string <date-time> Example: maxCreatedAt=2021-11-22 Optionally filter on the creation date
maxUpdatedAt	string <date-time> Example: maxUpdatedAt=2021-11-22 Optionally filter on the last update date
minCreatedAt	string <date-time> Example: minCreatedAt=2021-11-22 Optionally filter on the creation date
minUpdatedAt	string <date-time> Example: minUpdatedAt=2021-11-22 Optionally filter on the last update date
order	string Default: "DESC" Enum: "ASC" "DESC" The direction of the ordering
orderBy	string Default: "CREATED_AT" Value: "CREATED_AT" The field on which to sort
pageSize	integer Default: 20 The number of applications returned by page
searchTerm	string Optionally search for a substring of the application ID, application display name, job ID or job display name
state	any (oceanSparkApplicationState) Enum: "NEW" "SUBMITTED" "RUNNING" "COMPLETED" "FAILED" "SUBMISSION_FAILED" "UNKNOWN" Example: state=RUNNING Optionally filter on the state of the Spark application
submissionSource	string (oceanSparkApplicationSubmissionSource) Enum: "public-api" "jupyter-enterprise-gateway" Example: submissionSource=public-api Optionally filter on the submission source of the Spark application
userId	integer (userId) Example: userId=59438 Optionally filter on the user who created the Spark application

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"total": 3256,
"page": [{"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-11-01T10:50:29.000+0000",
"internalId": "fa61bb92-4bb7-49aa-87d3-7823bd263d1e",
"id": "daily-reporting-2021-08-18",
"displayName": "Daily Reporting 2021-08-18",
"userId": 59438,
"clusterId": "osc-20fac3f1",
"controllerClusterId": "my-ocean-cluster",
"appState": "RUNNING",
"submissionSource": "public-api",
"job": {"id": "daily-reporting",
"displayName": "Daily Reporting"
},
"config": {"arguments": ["string"
],
"deps": {"files": ["string"
],
"jars": ["string"
],
"pyFiles": ["string"
]
},
"driver": {"affinity": {"nodeAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"preference": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": {"nodeSelectorTerms": [{"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
}
]
}
},
"podAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
},
"podAntiAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
}
},
"annotations": {"property1": "string",
"property2": "string"
},
"configMaps": [{"name": "string",
"path": "string"
}
],
"coreLimit": "string",
"coreRequest": "string",
"cores": 0,
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envSecretKeyRefs": {"property1": {"key": "string",
"name": "string"
},
"property2": {"key": "string",
"name": "string"
}
},
"envVars": {"property1": "string",
"property2": "string"
},
"hostAliases": [{"hostnames": ["string"
],
"ip": "string"
}
],
"image": "string",
"instanceSelector": "string",
"instanceAllowList": "string",
"javaOptions": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"sidecars": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"initContainers": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"labels": {"property1": "string",
"property2": "string"
},
"memory": "string",
"memoryOverhead": "string",
"podName": "string",
"podSecurityContext": {"fsGroup": 0,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"supplementalGroups": [0
],
"sysctls": [{"name": "string",
"value": "string"
}
],
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"secrets": [{"name": "string",
"path": "string",
"secretType": "GCPServiceAccount"
}
],
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"spot": true,
"tolerations": [{"effect": "string",
"key": "string",
"operator": "string",
"tolerationSeconds": 0,
"value": "string"
}
],
"vngIds": ["string"
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
]
},
"executor": {"affinity": {"nodeAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"preference": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": {"nodeSelectorTerms": [{"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
}
]
}
},
"podAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
},
"podAntiAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
}
},
"annotations": {"property1": "string",
"property2": "string"
},
"configMaps": [{"name": "string",
"path": "string"
}
],
"coreLimit": "string",
"coreRequest": "string",
"cores": 0,
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envSecretKeyRefs": {"property1": {"key": "string",
"name": "string"
},
"property2": {"key": "string",
"name": "string"
}
},
"envVars": {"property1": "string",
"property2": "string"
},
"hostAliases": [{"hostnames": ["string"
],
"ip": "string"
}
],
"image": "string",
"instanceSelector": "string",
"instanceAllowList": "string",
"sidecars": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"initContainers": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"instances": 0,
"javaOptions": "string",
"labels": {"property1": "string",
"property2": "string"
},
"memory": "string",
"memoryOverhead": "string",
"podSecurityContext": {"fsGroup": 0,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"supplementalGroups": [0
],
"sysctls": [{"name": "string",
"value": "string"
}
],
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"secrets": [{"name": "string",
"path": "string",
"secretType": "GCPServiceAccount"
}
],
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"spot": true,
"tolerations": [{"effect": "string",
"key": "string",
"operator": "string",
"tolerationSeconds": 0,
"value": "string"
}
],
"vngIds": ["string"
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
]
},
"hadoopConf": {"property1": "string",
"property2": "string"
},
"hadoopConfigMap": "string",
"image": "string",
"imagePullPolicy": "string",
"imagePullSecrets": ["string"
],
"initContainerImage": "string",
"mainApplicationFile": "string",
"mainClass": "string",
"memoryOverheadFactor": "string",
"availabilityZone": "string",
"pythonVersion": "3",
"sparkConf": {"property1": "string",
"property2": "string"
},
"sparkConfigMap": "string",
"sparkVersion": "string",
"timeout": "DISABLED",
"timeToLiveSeconds": 0,
"type": "Java",
"volumes": [{"awsElasticBlockStore": {"fsType": "string",
"partition": 0,
"readOnly": true,
"volumeID": "string"
},
"azureDisk": {"cachingMode": "string",
"diskName": "string",
"diskURI": "string",
"fsType": "string",
"kind": "string",
"readOnly": true
},
"azureFile": {"readOnly": true,
"secretName": "string",
"shareName": "string"
},
"cephfs": {"monitors": ["string"
],
"path": "string",
"readOnly": true,
"secretFile": "string",
"secretRef": {"name": "string"
},
"user": "string"
},
"cinder": {"fsType": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"volumeID": "string"
},
"configMap": {"defaultMode": 0,
"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"csi": {"driver": "string",
"fsType": "string",
"nodePublishSecretRef": {"name": "string"
},
"readOnly": true,
"volumeAttributes": {"property1": "string",
"property2": "string"
}
},
"downwardAPI": {"defaultMode": 0,
"items": [{"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"mode": 0,
"path": "string",
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
}
}
]
},
"emptyDir": {"medium": "string",
"sizeLimit": "string"
},
"fc": {"fsType": "string",
"lun": 0,
"readOnly": true,
"targetWWNs": ["string"
],
"wwids": ["string"
]
},
"flexVolume": {"driver": "string",
"fsType": "string",
"options": {"property1": "string",
"property2": "string"
},
"readOnly": true,
"secretRef": {"name": "string"
}
},
"flocker": {"datasetName": "string",
"datasetUUID": "string"
},
"gcePersistentDisk": {"fsType": "string",
"partition": 0,
"pdName": "string",
"readOnly": true
},
"gitRepo": {"directory": "string",
"repository": "string",
"revision": "string"
},
"glusterfs": {"endpoints": "string",
"path": "string",
"readOnly": true
},
"hostPath": {"path": "string",
"type": "string"
},
"iscsi": {"chapAuthDiscovery": true,
"chapAuthSession": true,
"fsType": "string",
"initiatorName": "string",
"iqn": "string",
"iscsiInterface": "string",
"lun": 0,
"portals": ["string"
],
"readOnly": true,
"secretRef": {"name": "string"
},
"targetPortal": "string"
},
"name": "string",
"nfs": {"path": "string",
"readOnly": true,
"server": "string"
},
"persistentVolumeClaim": {"claimName": "string",
"readOnly": true
},
"photonPersistentDisk": {"fsType": "string",
"pdID": "string"
},
"portworxVolume": {"fsType": "string",
"readOnly": true,
"volumeID": "string"
},
"projected": {"defaultMode": 0,
"sources": [{"configMap": {"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"downwardAPI": {"items": [{"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"mode": 0,
"path": "string",
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
}
}
]
},
"secret": {"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"serviceAccountToken": {"audience": "string",
"expirationSeconds": 0,
"path": "string"
}
}
]
},
"quobyte": {"group": "string",
"readOnly": true,
"registry": "string",
"tenant": "string",
"user": "string",
"volume": "string"
},
"rbd": {"fsType": "string",
"image": "string",
"keyring": "string",
"monitors": ["string"
],
"pool": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"user": "string"
},
"scaleIO": {"fsType": "string",
"gateway": "string",
"protectionDomain": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"sslEnabled": true,
"storageMode": "string",
"storagePool": "string",
"system": "string",
"volumeName": "string"
},
"secret": {"defaultMode": 0,
"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"optional": true,
"secretName": "string"
},
"storageos": {"fsType": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"volumeName": "string",
"volumeNamespace": "string"
},
"vsphereVolume": {"fsType": "string",
"storagePolicyID": "string",
"storagePolicyName": "string",
"volumePath": "string"
}
}
]
},
"startedAt": "2021-11-18T17:09:37+00:00",
"endedAt": "2021-11-18T17:09:37+00:00",
"log": {"logsStreamUrl": "/ocean/spark/cluster/osc-20fac3f1/app/daily-reporting-2021-08-18/logs/live",
"kubeEventsStreamUrl": "/ocean/spark/cluster/osc-20fac3f1/app/daily-reporting-2021-08-18/kubeEvents/live"
},
"metrics": {"cost": {"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-10-10T10:50:29.000+0000",
"total": 0
},
"spark": {"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-10-10T10:50:29.000+0000",
"sparkCoresDurationSeconds": 0,
"inputDataBytes": 0,
"outputDataBytes": 0,
"durationSeconds": 0,
"efficiencyPercent": 0
}
}
}
],
"after": "MjAyMS0xMS0xOFQwOTo1MjowNS43Mzg4NjArMDA6MDB8NWM3NGY2MDYtZDYxNy00MzcxLWE5ZDktNjc2ZDkxMzRlNWFk",
"before": "MjAyMS0xMS0xOFQwOTo1MjowNS43Mzg4NjArMDA6MDB8NWM3NGY2MDYtZDYxNy00MzcxLWE5ZDktNjc2ZDkxMzRlNWFk"
}
],
"count": 1,
"kind": "string"
}
}

List Applications in Cluster

List the Spark applications in a specific cluster. This endpoint is paginated (cursor pagination).

Authorizations:

path Parameters

clusterId

required

string (oceanSparkClusterId)

Example: osc-20fac3f1

A unique identifier for the Ocean Spark cluster

query Parameters

accountId	string Example: accountId=act-123456789 The ID of the account associated with your token. If omitted the oldest account in the organization will be used.
after	string (after) Example: after=MjAyMS0xMS0xOFQwOTo1MjowNS43Mzg4NjArMDA6MDB8NWM3NGY2MDYtZDYxNy00MzcxLWE5ZDktNjc2ZDkxMzRlNWFk If specified, the page returned in the response contains the items right after this cursor in the ordering
before	string (before) Example: before=MjAyMS0xMS0xOFQwOTo1MjowNS43Mzg4NjArMDA6MDB8NWM3NGY2MDYtZDYxNy00MzcxLWE5ZDktNjc2ZDkxMzRlNWFk If specified, the page returned in the response contains the items right before this cursor in the ordering
jobId	string (oceanSparkJobId) ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a... Example: jobId=daily-reporting Optionally filter on the job ID
maxCreatedAt	string <date-time> Example: maxCreatedAt=2021-11-22 Optionally filter on the creation date
maxUpdatedAt	string <date-time> Example: maxUpdatedAt=2021-11-22 Optionally filter on the last update date
minCreatedAt	string <date-time> Example: minCreatedAt=2021-11-22 Optionally filter on the creation date
minUpdatedAt	string <date-time> Example: minUpdatedAt=2021-11-22 Optionally filter on the last update date
order	string Default: "DESC" Enum: "ASC" "DESC" The direction of the ordering
orderBy	string Default: "CREATED_AT" Value: "CREATED_AT" The field on which to sort
pageSize	integer Default: 20 The number of applications returned by page
searchTerm	string Optionally search for a substring of the application ID, application display name, job ID or job display name
state	any (oceanSparkApplicationState) Enum: "NEW" "SUBMITTED" "RUNNING" "COMPLETED" "FAILED" "SUBMISSION_FAILED" "UNKNOWN" Example: state=RUNNING Optionally filter on the state of the Spark application
submissionSource	string (oceanSparkApplicationSubmissionSource) Enum: "public-api" "jupyter-enterprise-gateway" Example: submissionSource=public-api Optionally filter on the submission source of the Spark application
userId	integer (userId) Example: userId=59438 Optionally filter on the user who created the Spark application

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"total": 3256,
"page": [{"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-11-01T10:50:29.000+0000",
"internalId": "fa61bb92-4bb7-49aa-87d3-7823bd263d1e",
"id": "daily-reporting-2021-08-18",
"displayName": "Daily Reporting 2021-08-18",
"userId": 59438,
"clusterId": "osc-20fac3f1",
"controllerClusterId": "my-ocean-cluster",
"appState": "RUNNING",
"submissionSource": "public-api",
"job": {"id": "daily-reporting",
"displayName": "Daily Reporting"
},
"config": {"arguments": ["string"
],
"deps": {"files": ["string"
],
"jars": ["string"
],
"pyFiles": ["string"
]
},
"driver": {"affinity": {"nodeAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"preference": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": {"nodeSelectorTerms": [{"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
}
]
}
},
"podAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
},
"podAntiAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
}
},
"annotations": {"property1": "string",
"property2": "string"
},
"configMaps": [{"name": "string",
"path": "string"
}
],
"coreLimit": "string",
"coreRequest": "string",
"cores": 0,
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envSecretKeyRefs": {"property1": {"key": "string",
"name": "string"
},
"property2": {"key": "string",
"name": "string"
}
},
"envVars": {"property1": "string",
"property2": "string"
},
"hostAliases": [{"hostnames": ["string"
],
"ip": "string"
}
],
"image": "string",
"instanceSelector": "string",
"instanceAllowList": "string",
"javaOptions": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"sidecars": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"initContainers": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"labels": {"property1": "string",
"property2": "string"
},
"memory": "string",
"memoryOverhead": "string",
"podName": "string",
"podSecurityContext": {"fsGroup": 0,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"supplementalGroups": [0
],
"sysctls": [{"name": "string",
"value": "string"
}
],
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"secrets": [{"name": "string",
"path": "string",
"secretType": "GCPServiceAccount"
}
],
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"spot": true,
"tolerations": [{"effect": "string",
"key": "string",
"operator": "string",
"tolerationSeconds": 0,
"value": "string"
}
],
"vngIds": ["string"
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
]
},
"executor": {"affinity": {"nodeAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"preference": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": {"nodeSelectorTerms": [{"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
}
]
}
},
"podAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
},
"podAntiAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
}
},
"annotations": {"property1": "string",
"property2": "string"
},
"configMaps": [{"name": "string",
"path": "string"
}
],
"coreLimit": "string",
"coreRequest": "string",
"cores": 0,
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envSecretKeyRefs": {"property1": {"key": "string",
"name": "string"
},
"property2": {"key": "string",
"name": "string"
}
},
"envVars": {"property1": "string",
"property2": "string"
},
"hostAliases": [{"hostnames": ["string"
],
"ip": "string"
}
],
"image": "string",
"instanceSelector": "string",
"instanceAllowList": "string",
"sidecars": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"initContainers": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"instances": 0,
"javaOptions": "string",
"labels": {"property1": "string",
"property2": "string"
},
"memory": "string",
"memoryOverhead": "string",
"podSecurityContext": {"fsGroup": 0,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"supplementalGroups": [0
],
"sysctls": [{"name": "string",
"value": "string"
}
],
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"secrets": [{"name": "string",
"path": "string",
"secretType": "GCPServiceAccount"
}
],
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"spot": true,
"tolerations": [{"effect": "string",
"key": "string",
"operator": "string",
"tolerationSeconds": 0,
"value": "string"
}
],
"vngIds": ["string"
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
]
},
"hadoopConf": {"property1": "string",
"property2": "string"
},
"hadoopConfigMap": "string",
"image": "string",
"imagePullPolicy": "string",
"imagePullSecrets": ["string"
],
"initContainerImage": "string",
"mainApplicationFile": "string",
"mainClass": "string",
"memoryOverheadFactor": "string",
"availabilityZone": "string",
"pythonVersion": "3",
"sparkConf": {"property1": "string",
"property2": "string"
},
"sparkConfigMap": "string",
"sparkVersion": "string",
"timeout": "DISABLED",
"timeToLiveSeconds": 0,
"type": "Java",
"volumes": [{"awsElasticBlockStore": {"fsType": "string",
"partition": 0,
"readOnly": true,
"volumeID": "string"
},
"azureDisk": {"cachingMode": "string",
"diskName": "string",
"diskURI": "string",
"fsType": "string",
"kind": "string",
"readOnly": true
},
"azureFile": {"readOnly": true,
"secretName": "string",
"shareName": "string"
},
"cephfs": {"monitors": ["string"
],
"path": "string",
"readOnly": true,
"secretFile": "string",
"secretRef": {"name": "string"
},
"user": "string"
},
"cinder": {"fsType": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"volumeID": "string"
},
"configMap": {"defaultMode": 0,
"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"csi": {"driver": "string",
"fsType": "string",
"nodePublishSecretRef": {"name": "string"
},
"readOnly": true,
"volumeAttributes": {"property1": "string",
"property2": "string"
}
},
"downwardAPI": {"defaultMode": 0,
"items": [{"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"mode": 0,
"path": "string",
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
}
}
]
},
"emptyDir": {"medium": "string",
"sizeLimit": "string"
},
"fc": {"fsType": "string",
"lun": 0,
"readOnly": true,
"targetWWNs": ["string"
],
"wwids": ["string"
]
},
"flexVolume": {"driver": "string",
"fsType": "string",
"options": {"property1": "string",
"property2": "string"
},
"readOnly": true,
"secretRef": {"name": "string"
}
},
"flocker": {"datasetName": "string",
"datasetUUID": "string"
},
"gcePersistentDisk": {"fsType": "string",
"partition": 0,
"pdName": "string",
"readOnly": true
},
"gitRepo": {"directory": "string",
"repository": "string",
"revision": "string"
},
"glusterfs": {"endpoints": "string",
"path": "string",
"readOnly": true
},
"hostPath": {"path": "string",
"type": "string"
},
"iscsi": {"chapAuthDiscovery": true,
"chapAuthSession": true,
"fsType": "string",
"initiatorName": "string",
"iqn": "string",
"iscsiInterface": "string",
"lun": 0,
"portals": ["string"
],
"readOnly": true,
"secretRef": {"name": "string"
},
"targetPortal": "string"
},
"name": "string",
"nfs": {"path": "string",
"readOnly": true,
"server": "string"
},
"persistentVolumeClaim": {"claimName": "string",
"readOnly": true
},
"photonPersistentDisk": {"fsType": "string",
"pdID": "string"
},
"portworxVolume": {"fsType": "string",
"readOnly": true,
"volumeID": "string"
},
"projected": {"defaultMode": 0,
"sources": [{"configMap": {"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"downwardAPI": {"items": [{"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"mode": 0,
"path": "string",
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
}
}
]
},
"secret": {"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"serviceAccountToken": {"audience": "string",
"expirationSeconds": 0,
"path": "string"
}
}
]
},
"quobyte": {"group": "string",
"readOnly": true,
"registry": "string",
"tenant": "string",
"user": "string",
"volume": "string"
},
"rbd": {"fsType": "string",
"image": "string",
"keyring": "string",
"monitors": ["string"
],
"pool": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"user": "string"
},
"scaleIO": {"fsType": "string",
"gateway": "string",
"protectionDomain": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"sslEnabled": true,
"storageMode": "string",
"storagePool": "string",
"system": "string",
"volumeName": "string"
},
"secret": {"defaultMode": 0,
"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"optional": true,
"secretName": "string"
},
"storageos": {"fsType": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"volumeName": "string",
"volumeNamespace": "string"
},
"vsphereVolume": {"fsType": "string",
"storagePolicyID": "string",
"storagePolicyName": "string",
"volumePath": "string"
}
}
]
},
"startedAt": "2021-11-18T17:09:37+00:00",
"endedAt": "2021-11-18T17:09:37+00:00",
"log": {"logsStreamUrl": "/ocean/spark/cluster/osc-20fac3f1/app/daily-reporting-2021-08-18/logs/live",
"kubeEventsStreamUrl": "/ocean/spark/cluster/osc-20fac3f1/app/daily-reporting-2021-08-18/kubeEvents/live"
},
"metrics": {"cost": {"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-10-10T10:50:29.000+0000",
"total": 0
},
"spark": {"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-10-10T10:50:29.000+0000",
"sparkCoresDurationSeconds": 0,
"inputDataBytes": 0,
"outputDataBytes": 0,
"durationSeconds": 0,
"efficiencyPercent": 0
}
}
}
],
"after": "MjAyMS0xMS0xOFQwOTo1MjowNS43Mzg4NjArMDA6MDB8NWM3NGY2MDYtZDYxNy00MzcxLWE5ZDktNjc2ZDkxMzRlNWFk",
"before": "MjAyMS0xMS0xOFQwOTo1MjowNS43Mzg4NjArMDA6MDB8NWM3NGY2MDYtZDYxNy00MzcxLWE5ZDktNjc2ZDkxMzRlNWFk"
}
],
"count": 1,
"kind": "string"
}
}

Submit an Application

Submit a Spark application in an Ocean Spark cluster

Authorizations:

path Parameters

clusterId

required

string (oceanSparkClusterId)

Example: osc-20fac3f1

A unique identifier for the Ocean Spark cluster

query Parameters

accountId

string

Example: accountId=act-123456789

The ID of the account associated with your token. If omitted the oldest account in the organization will be used.

Request Body schema: application/json

appId	string (oceanSparkApplicationId) ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a... A unique identifier for the Spark application, set by the user or auto-generated from the job ID
	object Configurations for the Spark application supplied in the request. Prefer using a config template for configurations that are stable across runs. Configurations in `configOverrides` have precedence over those in the config template.
configTemplateId	string (oceanSparkConfigTemplateId) ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a... A unique identifier for a configuration template, set by the user.
jobId required	string^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a... The ID of the job to which the Spark application belongs. If a job with this ID does not exist yet, it will be created.

Responses

Request samples

Payload

Content type

application/json

{"appId": "daily-reporting-2021-08-18",
"jobId": "daily-reporting",
"configOverrides": {"arguments": ["string"
],
"deps": {"files": ["string"
],
"jars": ["string"
],
"pyFiles": ["string"
]
},
"driver": {"affinity": {"nodeAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"preference": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": {"nodeSelectorTerms": [{"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
}
]
}
},
"podAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
},
"podAntiAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
}
},
"annotations": {"property1": "string",
"property2": "string"
},
"configMaps": [{"name": "string",
"path": "string"
}
],
"coreLimit": "string",
"coreRequest": "string",
"cores": 0,
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envSecretKeyRefs": {"property1": {"key": "string",
"name": "string"
},
"property2": {"key": "string",
"name": "string"
}
},
"envVars": {"property1": "string",
"property2": "string"
},
"hostAliases": [{"hostnames": ["string"
],
"ip": "string"
}
],
"image": "string",
"instanceSelector": "string",
"instanceAllowList": "string",
"javaOptions": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"sidecars": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"initContainers": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"labels": {"property1": "string",
"property2": "string"
},
"memory": "string",
"memoryOverhead": "string",
"podName": "string",
"podSecurityContext": {"fsGroup": 0,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"supplementalGroups": [0
],
"sysctls": [{"name": "string",
"value": "string"
}
],
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"secrets": [{"name": "string",
"path": "string",
"secretType": "GCPServiceAccount"
}
],
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"spot": true,
"tolerations": [{"effect": "string",
"key": "string",
"operator": "string",
"tolerationSeconds": 0,
"value": "string"
}
],
"vngIds": ["string"
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
]
},
"executor": {"affinity": {"nodeAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"preference": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": {"nodeSelectorTerms": [{"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
}
]
}
},
"podAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
},
"podAntiAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
}
},
"annotations": {"property1": "string",
"property2": "string"
},
"configMaps": [{"name": "string",
"path": "string"
}
],
"coreLimit": "string",
"coreRequest": "string",
"cores": 0,
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envSecretKeyRefs": {"property1": {"key": "string",
"name": "string"
},
"property2": {"key": "string",
"name": "string"
}
},
"envVars": {"property1": "string",
"property2": "string"
},
"hostAliases": [{"hostnames": ["string"
],
"ip": "string"
}
],
"image": "string",
"instanceSelector": "string",
"instanceAllowList": "string",
"sidecars": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"initContainers": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"instances": 0,
"javaOptions": "string",
"labels": {"property1": "string",
"property2": "string"
},
"memory": "string",
"memoryOverhead": "string",
"podSecurityContext": {"fsGroup": 0,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"supplementalGroups": [0
],
"sysctls": [{"name": "string",
"value": "string"
}
],
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"secrets": [{"name": "string",
"path": "string",
"secretType": "GCPServiceAccount"
}
],
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"spot": true,
"tolerations": [{"effect": "string",
"key": "string",
"operator": "string",
"tolerationSeconds": 0,
"value": "string"
}
],
"vngIds": ["string"
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
]
},
"hadoopConf": {"property1": "string",
"property2": "string"
},
"hadoopConfigMap": "string",
"image": "string",
"imagePullPolicy": "string",
"imagePullSecrets": ["string"
],
"initContainerImage": "string",
"mainApplicationFile": "string",
"mainClass": "string",
"memoryOverheadFactor": "string",
"availabilityZone": "string",
"pythonVersion": "3",
"sparkConf": {"property1": "string",
"property2": "string"
},
"sparkConfigMap": "string",
"sparkVersion": "string",
"timeout": "DISABLED",
"timeToLiveSeconds": 0,
"type": "Java",
"volumes": [{"awsElasticBlockStore": {"fsType": "string",
"partition": 0,
"readOnly": true,
"volumeID": "string"
},
"azureDisk": {"cachingMode": "string",
"diskName": "string",
"diskURI": "string",
"fsType": "string",
"kind": "string",
"readOnly": true
},
"azureFile": {"readOnly": true,
"secretName": "string",
"shareName": "string"
},
"cephfs": {"monitors": ["string"
],
"path": "string",
"readOnly": true,
"secretFile": "string",
"secretRef": {"name": "string"
},
"user": "string"
},
"cinder": {"fsType": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"volumeID": "string"
},
"configMap": {"defaultMode": 0,
"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"csi": {"driver": "string",
"fsType": "string",
"nodePublishSecretRef": {"name": "string"
},
"readOnly": true,
"volumeAttributes": {"property1": "string",
"property2": "string"
}
},
"downwardAPI": {"defaultMode": 0,
"items": [{"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"mode": 0,
"path": "string",
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
}
}
]
},
"emptyDir": {"medium": "string",
"sizeLimit": "string"
},
"fc": {"fsType": "string",
"lun": 0,
"readOnly": true,
"targetWWNs": ["string"
],
"wwids": ["string"
]
},
"flexVolume": {"driver": "string",
"fsType": "string",
"options": {"property1": "string",
"property2": "string"
},
"readOnly": true,
"secretRef": {"name": "string"
}
},
"flocker": {"datasetName": "string",
"datasetUUID": "string"
},
"gcePersistentDisk": {"fsType": "string",
"partition": 0,
"pdName": "string",
"readOnly": true
},
"gitRepo": {"directory": "string",
"repository": "string",
"revision": "string"
},
"glusterfs": {"endpoints": "string",
"path": "string",
"readOnly": true
},
"hostPath": {"path": "string",
"type": "string"
},
"iscsi": {"chapAuthDiscovery": true,
"chapAuthSession": true,
"fsType": "string",
"initiatorName": "string",
"iqn": "string",
"iscsiInterface": "string",
"lun": 0,
"portals": ["string"
],
"readOnly": true,
"secretRef": {"name": "string"
},
"targetPortal": "string"
},
"name": "string",
"nfs": {"path": "string",
"readOnly": true,
"server": "string"
},
"persistentVolumeClaim": {"claimName": "string",
"readOnly": true
},
"photonPersistentDisk": {"fsType": "string",
"pdID": "string"
},
"portworxVolume": {"fsType": "string",
"readOnly": true,
"volumeID": "string"
},
"projected": {"defaultMode": 0,
"sources": [{"configMap": {"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"downwardAPI": {"items": [{"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"mode": 0,
"path": "string",
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
}
}
]
},
"secret": {"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"serviceAccountToken": {"audience": "string",
"expirationSeconds": 0,
"path": "string"
}
}
]
},
"quobyte": {"group": "string",
"readOnly": true,
"registry": "string",
"tenant": "string",
"user": "string",
"volume": "string"
},
"rbd": {"fsType": "string",
"image": "string",
"keyring": "string",
"monitors": ["string"
],
"pool": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"user": "string"
},
"scaleIO": {"fsType": "string",
"gateway": "string",
"protectionDomain": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"sslEnabled": true,
"storageMode": "string",
"storagePool": "string",
"system": "string",
"volumeName": "string"
},
"secret": {"defaultMode": 0,
"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"optional": true,
"secretName": "string"
},
"storageos": {"fsType": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"volumeName": "string",
"volumeNamespace": "string"
},
"vsphereVolume": {"fsType": "string",
"storagePolicyID": "string",
"storagePolicyName": "string",
"volumePath": "string"
}
}
]
},
"configTemplateId": "large-app"
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-11-01T10:50:29.000+0000",
"internalId": "fa61bb92-4bb7-49aa-87d3-7823bd263d1e",
"id": "daily-reporting-2021-08-18",
"displayName": "Daily Reporting 2021-08-18",
"userId": 59438,
"clusterId": "osc-20fac3f1",
"controllerClusterId": "my-ocean-cluster",
"appState": "RUNNING",
"submissionSource": "public-api",
"job": {"id": "daily-reporting",
"displayName": "Daily Reporting"
},
"config": {"arguments": ["string"
],
"deps": {"files": ["string"
],
"jars": ["string"
],
"pyFiles": ["string"
]
},
"driver": {"affinity": {"nodeAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"preference": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": {"nodeSelectorTerms": [{"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
}
]
}
},
"podAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
},
"podAntiAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
}
},
"annotations": {"property1": "string",
"property2": "string"
},
"configMaps": [{"name": "string",
"path": "string"
}
],
"coreLimit": "string",
"coreRequest": "string",
"cores": 0,
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envSecretKeyRefs": {"property1": {"key": "string",
"name": "string"
},
"property2": {"key": "string",
"name": "string"
}
},
"envVars": {"property1": "string",
"property2": "string"
},
"hostAliases": [{"hostnames": ["string"
],
"ip": "string"
}
],
"image": "string",
"instanceSelector": "string",
"instanceAllowList": "string",
"javaOptions": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"sidecars": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"initContainers": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"labels": {"property1": "string",
"property2": "string"
},
"memory": "string",
"memoryOverhead": "string",
"podName": "string",
"podSecurityContext": {"fsGroup": 0,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"supplementalGroups": [0
],
"sysctls": [{"name": "string",
"value": "string"
}
],
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"secrets": [{"name": "string",
"path": "string",
"secretType": "GCPServiceAccount"
}
],
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"spot": true,
"tolerations": [{"effect": "string",
"key": "string",
"operator": "string",
"tolerationSeconds": 0,
"value": "string"
}
],
"vngIds": ["string"
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
]
},
"executor": {"affinity": {"nodeAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"preference": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": {"nodeSelectorTerms": [{"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
}
]
}
},
"podAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
},
"podAntiAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
}
},
"annotations": {"property1": "string",
"property2": "string"
},
"configMaps": [{"name": "string",
"path": "string"
}
],
"coreLimit": "string",
"coreRequest": "string",
"cores": 0,
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envSecretKeyRefs": {"property1": {"key": "string",
"name": "string"
},
"property2": {"key": "string",
"name": "string"
}
},
"envVars": {"property1": "string",
"property2": "string"
},
"hostAliases": [{"hostnames": ["string"
],
"ip": "string"
}
],
"image": "string",
"instanceSelector": "string",
"instanceAllowList": "string",
"sidecars": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"initContainers": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"instances": 0,
"javaOptions": "string",
"labels": {"property1": "string",
"property2": "string"
},
"memory": "string",
"memoryOverhead": "string",
"podSecurityContext": {"fsGroup": 0,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"supplementalGroups": [0
],
"sysctls": [{"name": "string",
"value": "string"
}
],
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"secrets": [{"name": "string",
"path": "string",
"secretType": "GCPServiceAccount"
}
],
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"spot": true,
"tolerations": [{"effect": "string",
"key": "string",
"operator": "string",
"tolerationSeconds": 0,
"value": "string"
}
],
"vngIds": ["string"
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
]
},
"hadoopConf": {"property1": "string",
"property2": "string"
},
"hadoopConfigMap": "string",
"image": "string",
"imagePullPolicy": "string",
"imagePullSecrets": ["string"
],
"initContainerImage": "string",
"mainApplicationFile": "string",
"mainClass": "string",
"memoryOverheadFactor": "string",
"availabilityZone": "string",
"pythonVersion": "3",
"sparkConf": {"property1": "string",
"property2": "string"
},
"sparkConfigMap": "string",
"sparkVersion": "string",
"timeout": "DISABLED",
"timeToLiveSeconds": 0,
"type": "Java",
"volumes": [{"awsElasticBlockStore": {"fsType": "string",
"partition": 0,
"readOnly": true,
"volumeID": "string"
},
"azureDisk": {"cachingMode": "string",
"diskName": "string",
"diskURI": "string",
"fsType": "string",
"kind": "string",
"readOnly": true
},
"azureFile": {"readOnly": true,
"secretName": "string",
"shareName": "string"
},
"cephfs": {"monitors": ["string"
],
"path": "string",
"readOnly": true,
"secretFile": "string",
"secretRef": {"name": "string"
},
"user": "string"
},
"cinder": {"fsType": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"volumeID": "string"
},
"configMap": {"defaultMode": 0,
"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"csi": {"driver": "string",
"fsType": "string",
"nodePublishSecretRef": {"name": "string"
},
"readOnly": true,
"volumeAttributes": {"property1": "string",
"property2": "string"
}
},
"downwardAPI": {"defaultMode": 0,
"items": [{"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"mode": 0,
"path": "string",
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
}
}
]
},
"emptyDir": {"medium": "string",
"sizeLimit": "string"
},
"fc": {"fsType": "string",
"lun": 0,
"readOnly": true,
"targetWWNs": ["string"
],
"wwids": ["string"
]
},
"flexVolume": {"driver": "string",
"fsType": "string",
"options": {"property1": "string",
"property2": "string"
},
"readOnly": true,
"secretRef": {"name": "string"
}
},
"flocker": {"datasetName": "string",
"datasetUUID": "string"
},
"gcePersistentDisk": {"fsType": "string",
"partition": 0,
"pdName": "string",
"readOnly": true
},
"gitRepo": {"directory": "string",
"repository": "string",
"revision": "string"
},
"glusterfs": {"endpoints": "string",
"path": "string",
"readOnly": true
},
"hostPath": {"path": "string",
"type": "string"
},
"iscsi": {"chapAuthDiscovery": true,
"chapAuthSession": true,
"fsType": "string",
"initiatorName": "string",
"iqn": "string",
"iscsiInterface": "string",
"lun": 0,
"portals": ["string"
],
"readOnly": true,
"secretRef": {"name": "string"
},
"targetPortal": "string"
},
"name": "string",
"nfs": {"path": "string",
"readOnly": true,
"server": "string"
},
"persistentVolumeClaim": {"claimName": "string",
"readOnly": true
},
"photonPersistentDisk": {"fsType": "string",
"pdID": "string"
},
"portworxVolume": {"fsType": "string",
"readOnly": true,
"volumeID": "string"
},
"projected": {"defaultMode": 0,
"sources": [{"configMap": {"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"downwardAPI": {"items": [{"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"mode": 0,
"path": "string",
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
}
}
]
},
"secret": {"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"serviceAccountToken": {"audience": "string",
"expirationSeconds": 0,
"path": "string"
}
}
]
},
"quobyte": {"group": "string",
"readOnly": true,
"registry": "string",
"tenant": "string",
"user": "string",
"volume": "string"
},
"rbd": {"fsType": "string",
"image": "string",
"keyring": "string",
"monitors": ["string"
],
"pool": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"user": "string"
},
"scaleIO": {"fsType": "string",
"gateway": "string",
"protectionDomain": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"sslEnabled": true,
"storageMode": "string",
"storagePool": "string",
"system": "string",
"volumeName": "string"
},
"secret": {"defaultMode": 0,
"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"optional": true,
"secretName": "string"
},
"storageos": {"fsType": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"volumeName": "string",
"volumeNamespace": "string"
},
"vsphereVolume": {"fsType": "string",
"storagePolicyID": "string",
"storagePolicyName": "string",
"volumePath": "string"
}
}
]
},
"startedAt": "2021-11-18T17:09:37+00:00",
"endedAt": "2021-11-18T17:09:37+00:00",
"log": {"logsStreamUrl": "/ocean/spark/cluster/osc-20fac3f1/app/daily-reporting-2021-08-18/logs/live",
"kubeEventsStreamUrl": "/ocean/spark/cluster/osc-20fac3f1/app/daily-reporting-2021-08-18/kubeEvents/live"
},
"metrics": {"cost": {"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-10-10T10:50:29.000+0000",
"total": 0
},
"spark": {"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-10-10T10:50:29.000+0000",
"sparkCoresDurationSeconds": 0,
"inputDataBytes": 0,
"outputDataBytes": 0,
"durationSeconds": 0,
"efficiencyPercent": 0
}
}
}
],
"count": 1,
"kind": "string"
}
}

Get Application

Describe a Spark application in an Ocean Spark cluster.

Authorizations:

path Parameters

applicationId required	string (oceanSparkApplicationId) ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a... Example: daily-reporting-2021-08-18 A unique identifier for the Spark application, set by the user or auto-generated from the job ID
clusterId required	string (oceanSparkClusterId) Example: osc-20fac3f1 A unique identifier for the Ocean Spark cluster

query Parameters

accountId

string

Example: accountId=act-123456789

The ID of the account associated with your token. If omitted the oldest account in the organization will be used.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-11-01T10:50:29.000+0000",
"internalId": "fa61bb92-4bb7-49aa-87d3-7823bd263d1e",
"id": "daily-reporting-2021-08-18",
"displayName": "Daily Reporting 2021-08-18",
"userId": 59438,
"clusterId": "osc-20fac3f1",
"controllerClusterId": "my-ocean-cluster",
"appState": "RUNNING",
"submissionSource": "public-api",
"job": {"id": "daily-reporting",
"displayName": "Daily Reporting"
},
"config": {"arguments": ["string"
],
"deps": {"files": ["string"
],
"jars": ["string"
],
"pyFiles": ["string"
]
},
"driver": {"affinity": {"nodeAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"preference": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": {"nodeSelectorTerms": [{"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
}
]
}
},
"podAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
},
"podAntiAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
}
},
"annotations": {"property1": "string",
"property2": "string"
},
"configMaps": [{"name": "string",
"path": "string"
}
],
"coreLimit": "string",
"coreRequest": "string",
"cores": 0,
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envSecretKeyRefs": {"property1": {"key": "string",
"name": "string"
},
"property2": {"key": "string",
"name": "string"
}
},
"envVars": {"property1": "string",
"property2": "string"
},
"hostAliases": [{"hostnames": ["string"
],
"ip": "string"
}
],
"image": "string",
"instanceSelector": "string",
"instanceAllowList": "string",
"javaOptions": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"sidecars": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"initContainers": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"labels": {"property1": "string",
"property2": "string"
},
"memory": "string",
"memoryOverhead": "string",
"podName": "string",
"podSecurityContext": {"fsGroup": 0,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"supplementalGroups": [0
],
"sysctls": [{"name": "string",
"value": "string"
}
],
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"secrets": [{"name": "string",
"path": "string",
"secretType": "GCPServiceAccount"
}
],
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"spot": true,
"tolerations": [{"effect": "string",
"key": "string",
"operator": "string",
"tolerationSeconds": 0,
"value": "string"
}
],
"vngIds": ["string"
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
]
},
"executor": {"affinity": {"nodeAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"preference": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": {"nodeSelectorTerms": [{"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
}
]
}
},
"podAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
},
"podAntiAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
}
},
"annotations": {"property1": "string",
"property2": "string"
},
"configMaps": [{"name": "string",
"path": "string"
}
],
"coreLimit": "string",
"coreRequest": "string",
"cores": 0,
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envSecretKeyRefs": {"property1": {"key": "string",
"name": "string"
},
"property2": {"key": "string",
"name": "string"
}
},
"envVars": {"property1": "string",
"property2": "string"
},
"hostAliases": [{"hostnames": ["string"
],
"ip": "string"
}
],
"image": "string",
"instanceSelector": "string",
"instanceAllowList": "string",
"sidecars": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"initContainers": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"instances": 0,
"javaOptions": "string",
"labels": {"property1": "string",
"property2": "string"
},
"memory": "string",
"memoryOverhead": "string",
"podSecurityContext": {"fsGroup": 0,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"supplementalGroups": [0
],
"sysctls": [{"name": "string",
"value": "string"
}
],
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"secrets": [{"name": "string",
"path": "string",
"secretType": "GCPServiceAccount"
}
],
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"spot": true,
"tolerations": [{"effect": "string",
"key": "string",
"operator": "string",
"tolerationSeconds": 0,
"value": "string"
}
],
"vngIds": ["string"
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
]
},
"hadoopConf": {"property1": "string",
"property2": "string"
},
"hadoopConfigMap": "string",
"image": "string",
"imagePullPolicy": "string",
"imagePullSecrets": ["string"
],
"initContainerImage": "string",
"mainApplicationFile": "string",
"mainClass": "string",
"memoryOverheadFactor": "string",
"availabilityZone": "string",
"pythonVersion": "3",
"sparkConf": {"property1": "string",
"property2": "string"
},
"sparkConfigMap": "string",
"sparkVersion": "string",
"timeout": "DISABLED",
"timeToLiveSeconds": 0,
"type": "Java",
"volumes": [{"awsElasticBlockStore": {"fsType": "string",
"partition": 0,
"readOnly": true,
"volumeID": "string"
},
"azureDisk": {"cachingMode": "string",
"diskName": "string",
"diskURI": "string",
"fsType": "string",
"kind": "string",
"readOnly": true
},
"azureFile": {"readOnly": true,
"secretName": "string",
"shareName": "string"
},
"cephfs": {"monitors": ["string"
],
"path": "string",
"readOnly": true,
"secretFile": "string",
"secretRef": {"name": "string"
},
"user": "string"
},
"cinder": {"fsType": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"volumeID": "string"
},
"configMap": {"defaultMode": 0,
"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"csi": {"driver": "string",
"fsType": "string",
"nodePublishSecretRef": {"name": "string"
},
"readOnly": true,
"volumeAttributes": {"property1": "string",
"property2": "string"
}
},
"downwardAPI": {"defaultMode": 0,
"items": [{"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"mode": 0,
"path": "string",
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
}
}
]
},
"emptyDir": {"medium": "string",
"sizeLimit": "string"
},
"fc": {"fsType": "string",
"lun": 0,
"readOnly": true,
"targetWWNs": ["string"
],
"wwids": ["string"
]
},
"flexVolume": {"driver": "string",
"fsType": "string",
"options": {"property1": "string",
"property2": "string"
},
"readOnly": true,
"secretRef": {"name": "string"
}
},
"flocker": {"datasetName": "string",
"datasetUUID": "string"
},
"gcePersistentDisk": {"fsType": "string",
"partition": 0,
"pdName": "string",
"readOnly": true
},
"gitRepo": {"directory": "string",
"repository": "string",
"revision": "string"
},
"glusterfs": {"endpoints": "string",
"path": "string",
"readOnly": true
},
"hostPath": {"path": "string",
"type": "string"
},
"iscsi": {"chapAuthDiscovery": true,
"chapAuthSession": true,
"fsType": "string",
"initiatorName": "string",
"iqn": "string",
"iscsiInterface": "string",
"lun": 0,
"portals": ["string"
],
"readOnly": true,
"secretRef": {"name": "string"
},
"targetPortal": "string"
},
"name": "string",
"nfs": {"path": "string",
"readOnly": true,
"server": "string"
},
"persistentVolumeClaim": {"claimName": "string",
"readOnly": true
},
"photonPersistentDisk": {"fsType": "string",
"pdID": "string"
},
"portworxVolume": {"fsType": "string",
"readOnly": true,
"volumeID": "string"
},
"projected": {"defaultMode": 0,
"sources": [{"configMap": {"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"downwardAPI": {"items": [{"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"mode": 0,
"path": "string",
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
}
}
]
},
"secret": {"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"serviceAccountToken": {"audience": "string",
"expirationSeconds": 0,
"path": "string"
}
}
]
},
"quobyte": {"group": "string",
"readOnly": true,
"registry": "string",
"tenant": "string",
"user": "string",
"volume": "string"
},
"rbd": {"fsType": "string",
"image": "string",
"keyring": "string",
"monitors": ["string"
],
"pool": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"user": "string"
},
"scaleIO": {"fsType": "string",
"gateway": "string",
"protectionDomain": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"sslEnabled": true,
"storageMode": "string",
"storagePool": "string",
"system": "string",
"volumeName": "string"
},
"secret": {"defaultMode": 0,
"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"optional": true,
"secretName": "string"
},
"storageos": {"fsType": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"volumeName": "string",
"volumeNamespace": "string"
},
"vsphereVolume": {"fsType": "string",
"storagePolicyID": "string",
"storagePolicyName": "string",
"volumePath": "string"
}
}
]
},
"startedAt": "2021-11-18T17:09:37+00:00",
"endedAt": "2021-11-18T17:09:37+00:00",
"log": {"logsStreamUrl": "/ocean/spark/cluster/osc-20fac3f1/app/daily-reporting-2021-08-18/logs/live",
"kubeEventsStreamUrl": "/ocean/spark/cluster/osc-20fac3f1/app/daily-reporting-2021-08-18/kubeEvents/live"
},
"metrics": {"cost": {"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-10-10T10:50:29.000+0000",
"total": 0
},
"spark": {"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-10-10T10:50:29.000+0000",
"sparkCoresDurationSeconds": 0,
"inputDataBytes": 0,
"outputDataBytes": 0,
"durationSeconds": 0,
"efficiencyPercent": 0
}
}
}
],
"count": 1,
"kind": "string"
}
}

Delete or kill an Application

For pending Spark applications, the creation request is canceled. For running Spark applications, the application is forcibly interrupted.

Authorizations:

path Parameters

applicationId required	string (oceanSparkApplicationId) ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a... Example: daily-reporting-2021-08-18 A unique identifier for the Spark application, set by the user or auto-generated from the job ID
clusterId required	string (oceanSparkClusterId) Example: osc-20fac3f1 A unique identifier for the Ocean Spark cluster

query Parameters

accountId

string

Example: accountId=act-123456789

The ID of the account associated with your token. If omitted the oldest account in the organization will be used.

Responses

Stream Driver log

Stream the driver log of a Spark application in real time.

Authorizations:

path Parameters

applicationId required	string (oceanSparkApplicationId) ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a... Example: daily-reporting-2021-08-18 A unique identifier for the Spark application, set by the user or auto-generated from the job ID
clusterId required	string (oceanSparkClusterId) Example: osc-20fac3f1 A unique identifier for the Ocean Spark cluster

query Parameters

accountId

string

Example: accountId=act-123456789

The ID of the account associated with your token. If omitted the oldest account in the organization will be used.

Responses

Download Driver log

Download an archive of the driver logs for a finished spark application.

Authorizations:

path Parameters

applicationId required	string (oceanSparkApplicationId) ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a... Example: daily-reporting-2021-08-18 A unique identifier for the Spark application, set by the user or auto-generated from the job ID
clusterId required	string (oceanSparkClusterId) Example: osc-20fac3f1 A unique identifier for the Ocean Spark cluster

query Parameters

accountId

string

Example: accountId=act-123456789

The ID of the account associated with your token. If omitted the oldest account in the organization will be used.

Responses

Stream Kubernetes events

Stream Kubernetes events about the Spark application in real time.

Authorizations:

path Parameters

applicationId required	string (oceanSparkApplicationId) ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a... Example: daily-reporting-2021-08-18 A unique identifier for the Spark application, set by the user or auto-generated from the job ID
clusterId required	string (oceanSparkClusterId) Example: osc-20fac3f1 A unique identifier for the Ocean Spark cluster

query Parameters

accountId

string

Example: accountId=act-123456789

The ID of the account associated with your token. If omitted the oldest account in the organization will be used.

Responses

List Config Templates

List config templates across all clusters.

Authorizations:

query Parameters

accountId

string

Example: accountId=act-123456789

The ID of the account associated with your token. If omitted the oldest account in the organization will be used.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-11-01T10:50:29.000+0000",
"id": "large-app",
"displayName": "Large application",
"clusterId": "osc-20fac3f1",
"config": {"arguments": ["string"
],
"deps": {"files": ["string"
],
"jars": ["string"
],
"pyFiles": ["string"
]
},
"driver": {"affinity": {"nodeAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"preference": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": {"nodeSelectorTerms": [{"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
}
]
}
},
"podAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
},
"podAntiAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
}
},
"annotations": {"property1": "string",
"property2": "string"
},
"configMaps": [{"name": "string",
"path": "string"
}
],
"coreLimit": "string",
"coreRequest": "string",
"cores": 0,
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envSecretKeyRefs": {"property1": {"key": "string",
"name": "string"
},
"property2": {"key": "string",
"name": "string"
}
},
"envVars": {"property1": "string",
"property2": "string"
},
"hostAliases": [{"hostnames": ["string"
],
"ip": "string"
}
],
"image": "string",
"instanceSelector": "string",
"instanceAllowList": "string",
"javaOptions": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"sidecars": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"initContainers": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"labels": {"property1": "string",
"property2": "string"
},
"memory": "string",
"memoryOverhead": "string",
"podName": "string",
"podSecurityContext": {"fsGroup": 0,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"supplementalGroups": [0
],
"sysctls": [{"name": "string",
"value": "string"
}
],
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"secrets": [{"name": "string",
"path": "string",
"secretType": "GCPServiceAccount"
}
],
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"spot": true,
"tolerations": [{"effect": "string",
"key": "string",
"operator": "string",
"tolerationSeconds": 0,
"value": "string"
}
],
"vngIds": ["string"
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
]
},
"executor": {"affinity": {"nodeAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"preference": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": {"nodeSelectorTerms": [{"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
}
]
}
},
"podAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
},
"podAntiAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
}
},
"annotations": {"property1": "string",
"property2": "string"
},
"configMaps": [{"name": "string",
"path": "string"
}
],
"coreLimit": "string",
"coreRequest": "string",
"cores": 0,
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envSecretKeyRefs": {"property1": {"key": "string",
"name": "string"
},
"property2": {"key": "string",
"name": "string"
}
},
"envVars": {"property1": "string",
"property2": "string"
},
"hostAliases": [{"hostnames": ["string"
],
"ip": "string"
}
],
"image": "string",
"instanceSelector": "string",
"instanceAllowList": "string",
"sidecars": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"initContainers": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"instances": 0,
"javaOptions": "string",
"labels": {"property1": "string",
"property2": "string"
},
"memory": "string",
"memoryOverhead": "string",
"podSecurityContext": {"fsGroup": 0,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"supplementalGroups": [0
],
"sysctls": [{"name": "string",
"value": "string"
}
],
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"secrets": [{"name": "string",
"path": "string",
"secretType": "GCPServiceAccount"
}
],
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"spot": true,
"tolerations": [{"effect": "string",
"key": "string",
"operator": "string",
"tolerationSeconds": 0,
"value": "string"
}
],
"vngIds": ["string"
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
]
},
"hadoopConf": {"property1": "string",
"property2": "string"
},
"hadoopConfigMap": "string",
"image": "string",
"imagePullPolicy": "string",
"imagePullSecrets": ["string"
],
"initContainerImage": "string",
"mainApplicationFile": "string",
"mainClass": "string",
"memoryOverheadFactor": "string",
"availabilityZone": "string",
"pythonVersion": "3",
"sparkConf": {"property1": "string",
"property2": "string"
},
"sparkConfigMap": "string",
"sparkVersion": "string",
"timeout": "DISABLED",
"timeToLiveSeconds": 0,
"type": "Java",
"volumes": [{"awsElasticBlockStore": {"fsType": "string",
"partition": 0,
"readOnly": true,
"volumeID": "string"
},
"azureDisk": {"cachingMode": "string",
"diskName": "string",
"diskURI": "string",
"fsType": "string",
"kind": "string",
"readOnly": true
},
"azureFile": {"readOnly": true,
"secretName": "string",
"shareName": "string"
},
"cephfs": {"monitors": ["string"
],
"path": "string",
"readOnly": true,
"secretFile": "string",
"secretRef": {"name": "string"
},
"user": "string"
},
"cinder": {"fsType": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"volumeID": "string"
},
"configMap": {"defaultMode": 0,
"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"csi": {"driver": "string",
"fsType": "string",
"nodePublishSecretRef": {"name": "string"
},
"readOnly": true,
"volumeAttributes": {"property1": "string",
"property2": "string"
}
},
"downwardAPI": {"defaultMode": 0,
"items": [{"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"mode": 0,
"path": "string",
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
}
}
]
},
"emptyDir": {"medium": "string",
"sizeLimit": "string"
},
"fc": {"fsType": "string",
"lun": 0,
"readOnly": true,
"targetWWNs": ["string"
],
"wwids": ["string"
]
},
"flexVolume": {"driver": "string",
"fsType": "string",
"options": {"property1": "string",
"property2": "string"
},
"readOnly": true,
"secretRef": {"name": "string"
}
},
"flocker": {"datasetName": "string",
"datasetUUID": "string"
},
"gcePersistentDisk": {"fsType": "string",
"partition": 0,
"pdName": "string",
"readOnly": true
},
"gitRepo": {"directory": "string",
"repository": "string",
"revision": "string"
},
"glusterfs": {"endpoints": "string",
"path": "string",
"readOnly": true
},
"hostPath": {"path": "string",
"type": "string"
},
"iscsi": {"chapAuthDiscovery": true,
"chapAuthSession": true,
"fsType": "string",
"initiatorName": "string",
"iqn": "string",
"iscsiInterface": "string",
"lun": 0,
"portals": ["string"
],
"readOnly": true,
"secretRef": {"name": "string"
},
"targetPortal": "string"
},
"name": "string",
"nfs": {"path": "string",
"readOnly": true,
"server": "string"
},
"persistentVolumeClaim": {"claimName": "string",
"readOnly": true
},
"photonPersistentDisk": {"fsType": "string",
"pdID": "string"
},
"portworxVolume": {"fsType": "string",
"readOnly": true,
"volumeID": "string"
},
"projected": {"defaultMode": 0,
"sources": [{"configMap": {"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"downwardAPI": {"items": [{"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"mode": 0,
"path": "string",
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
}
}
]
},
"secret": {"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"serviceAccountToken": {"audience": "string",
"expirationSeconds": 0,
"path": "string"
}
}
]
},
"quobyte": {"group": "string",
"readOnly": true,
"registry": "string",
"tenant": "string",
"user": "string",
"volume": "string"
},
"rbd": {"fsType": "string",
"image": "string",
"keyring": "string",
"monitors": ["string"
],
"pool": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"user": "string"
},
"scaleIO": {"fsType": "string",
"gateway": "string",
"protectionDomain": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"sslEnabled": true,
"storageMode": "string",
"storagePool": "string",
"system": "string",
"volumeName": "string"
},
"secret": {"defaultMode": 0,
"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"optional": true,
"secretName": "string"
},
"storageos": {"fsType": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"volumeName": "string",
"volumeNamespace": "string"
},
"vsphereVolume": {"fsType": "string",
"storagePolicyID": "string",
"storagePolicyName": "string",
"volumePath": "string"
}
}
]
}
}
],
"count": 1,
"kind": "string"
}
}

List Config Templates in Cluster

List the config templates tied to a specific cluster.

Authorizations:

path Parameters

clusterId

required

string (oceanSparkClusterId)

Example: osc-20fac3f1

A unique identifier for the Ocean Spark cluster

query Parameters

accountId

string

Example: accountId=act-123456789

The ID of the account associated with your token. If omitted the oldest account in the organization will be used.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-11-01T10:50:29.000+0000",
"id": "large-app",
"displayName": "Large application",
"clusterId": "osc-20fac3f1",
"config": {"arguments": ["string"
],
"deps": {"files": ["string"
],
"jars": ["string"
],
"pyFiles": ["string"
]
},
"driver": {"affinity": {"nodeAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"preference": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": {"nodeSelectorTerms": [{"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
}
]
}
},
"podAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
},
"podAntiAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
}
},
"annotations": {"property1": "string",
"property2": "string"
},
"configMaps": [{"name": "string",
"path": "string"
}
],
"coreLimit": "string",
"coreRequest": "string",
"cores": 0,
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envSecretKeyRefs": {"property1": {"key": "string",
"name": "string"
},
"property2": {"key": "string",
"name": "string"
}
},
"envVars": {"property1": "string",
"property2": "string"
},
"hostAliases": [{"hostnames": ["string"
],
"ip": "string"
}
],
"image": "string",
"instanceSelector": "string",
"instanceAllowList": "string",
"javaOptions": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"sidecars": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"initContainers": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"labels": {"property1": "string",
"property2": "string"
},
"memory": "string",
"memoryOverhead": "string",
"podName": "string",
"podSecurityContext": {"fsGroup": 0,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"supplementalGroups": [0
],
"sysctls": [{"name": "string",
"value": "string"
}
],
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"secrets": [{"name": "string",
"path": "string",
"secretType": "GCPServiceAccount"
}
],
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"spot": true,
"tolerations": [{"effect": "string",
"key": "string",
"operator": "string",
"tolerationSeconds": 0,
"value": "string"
}
],
"vngIds": ["string"
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
]
},
"executor": {"affinity": {"nodeAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"preference": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": {"nodeSelectorTerms": [{"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
}
]
}
},
"podAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
},
"podAntiAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
}
},
"annotations": {"property1": "string",
"property2": "string"
},
"configMaps": [{"name": "string",
"path": "string"
}
],
"coreLimit": "string",
"coreRequest": "string",
"cores": 0,
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envSecretKeyRefs": {"property1": {"key": "string",
"name": "string"
},
"property2": {"key": "string",
"name": "string"
}
},
"envVars": {"property1": "string",
"property2": "string"
},
"hostAliases": [{"hostnames": ["string"
],
"ip": "string"
}
],
"image": "string",
"instanceSelector": "string",
"instanceAllowList": "string",
"sidecars": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"initContainers": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"instances": 0,
"javaOptions": "string",
"labels": {"property1": "string",
"property2": "string"
},
"memory": "string",
"memoryOverhead": "string",
"podSecurityContext": {"fsGroup": 0,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"supplementalGroups": [0
],
"sysctls": [{"name": "string",
"value": "string"
}
],
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"secrets": [{"name": "string",
"path": "string",
"secretType": "GCPServiceAccount"
}
],
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"spot": true,
"tolerations": [{"effect": "string",
"key": "string",
"operator": "string",
"tolerationSeconds": 0,
"value": "string"
}
],
"vngIds": ["string"
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
]
},
"hadoopConf": {"property1": "string",
"property2": "string"
},
"hadoopConfigMap": "string",
"image": "string",
"imagePullPolicy": "string",
"imagePullSecrets": ["string"
],
"initContainerImage": "string",
"mainApplicationFile": "string",
"mainClass": "string",
"memoryOverheadFactor": "string",
"availabilityZone": "string",
"pythonVersion": "3",
"sparkConf": {"property1": "string",
"property2": "string"
},
"sparkConfigMap": "string",
"sparkVersion": "string",
"timeout": "DISABLED",
"timeToLiveSeconds": 0,
"type": "Java",
"volumes": [{"awsElasticBlockStore": {"fsType": "string",
"partition": 0,
"readOnly": true,
"volumeID": "string"
},
"azureDisk": {"cachingMode": "string",
"diskName": "string",
"diskURI": "string",
"fsType": "string",
"kind": "string",
"readOnly": true
},
"azureFile": {"readOnly": true,
"secretName": "string",
"shareName": "string"
},
"cephfs": {"monitors": ["string"
],
"path": "string",
"readOnly": true,
"secretFile": "string",
"secretRef": {"name": "string"
},
"user": "string"
},
"cinder": {"fsType": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"volumeID": "string"
},
"configMap": {"defaultMode": 0,
"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"csi": {"driver": "string",
"fsType": "string",
"nodePublishSecretRef": {"name": "string"
},
"readOnly": true,
"volumeAttributes": {"property1": "string",
"property2": "string"
}
},
"downwardAPI": {"defaultMode": 0,
"items": [{"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"mode": 0,
"path": "string",
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
}
}
]
},
"emptyDir": {"medium": "string",
"sizeLimit": "string"
},
"fc": {"fsType": "string",
"lun": 0,
"readOnly": true,
"targetWWNs": ["string"
],
"wwids": ["string"
]
},
"flexVolume": {"driver": "string",
"fsType": "string",
"options": {"property1": "string",
"property2": "string"
},
"readOnly": true,
"secretRef": {"name": "string"
}
},
"flocker": {"datasetName": "string",
"datasetUUID": "string"
},
"gcePersistentDisk": {"fsType": "string",
"partition": 0,
"pdName": "string",
"readOnly": true
},
"gitRepo": {"directory": "string",
"repository": "string",
"revision": "string"
},
"glusterfs": {"endpoints": "string",
"path": "string",
"readOnly": true
},
"hostPath": {"path": "string",
"type": "string"
},
"iscsi": {"chapAuthDiscovery": true,
"chapAuthSession": true,
"fsType": "string",
"initiatorName": "string",
"iqn": "string",
"iscsiInterface": "string",
"lun": 0,
"portals": ["string"
],
"readOnly": true,
"secretRef": {"name": "string"
},
"targetPortal": "string"
},
"name": "string",
"nfs": {"path": "string",
"readOnly": true,
"server": "string"
},
"persistentVolumeClaim": {"claimName": "string",
"readOnly": true
},
"photonPersistentDisk": {"fsType": "string",
"pdID": "string"
},
"portworxVolume": {"fsType": "string",
"readOnly": true,
"volumeID": "string"
},
"projected": {"defaultMode": 0,
"sources": [{"configMap": {"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"downwardAPI": {"items": [{"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"mode": 0,
"path": "string",
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
}
}
]
},
"secret": {"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"serviceAccountToken": {"audience": "string",
"expirationSeconds": 0,
"path": "string"
}
}
]
},
"quobyte": {"group": "string",
"readOnly": true,
"registry": "string",
"tenant": "string",
"user": "string",
"volume": "string"
},
"rbd": {"fsType": "string",
"image": "string",
"keyring": "string",
"monitors": ["string"
],
"pool": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"user": "string"
},
"scaleIO": {"fsType": "string",
"gateway": "string",
"protectionDomain": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"sslEnabled": true,
"storageMode": "string",
"storagePool": "string",
"system": "string",
"volumeName": "string"
},
"secret": {"defaultMode": 0,
"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"optional": true,
"secretName": "string"
},
"storageos": {"fsType": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"volumeName": "string",
"volumeNamespace": "string"
},
"vsphereVolume": {"fsType": "string",
"storagePolicyID": "string",
"storagePolicyName": "string",
"volumePath": "string"
}
}
]
}
}
],
"count": 1,
"kind": "string"
}
}

Create Config Template

Create a new configuration template

Authorizations:

path Parameters

clusterId

required

string (oceanSparkClusterId)

Example: osc-20fac3f1

A unique identifier for the Ocean Spark cluster

query Parameters

accountId

string

Example: accountId=act-123456789

The ID of the account associated with your token. If omitted the oldest account in the organization will be used.

Request Body schema: application/json

required	object The piece of configuration contained in the config template.
displayName	string (oceanSparkConfigTemplateDisplayName) A non-unique free-form name for the config template used in the Spot console. Defaults to the config template ID.
id required	string (oceanSparkConfigTemplateId) ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a... A unique identifier for a configuration template, set by the user.

Responses

Request samples

Payload

Content type

application/json

{"id": "large-app",
"displayName": "Large application",
"config": {"arguments": ["string"
],
"deps": {"files": ["string"
],
"jars": ["string"
],
"pyFiles": ["string"
]
},
"driver": {"affinity": {"nodeAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"preference": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": {"nodeSelectorTerms": [{"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
}
]
}
},
"podAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
},
"podAntiAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
}
},
"annotations": {"property1": "string",
"property2": "string"
},
"configMaps": [{"name": "string",
"path": "string"
}
],
"coreLimit": "string",
"coreRequest": "string",
"cores": 0,
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envSecretKeyRefs": {"property1": {"key": "string",
"name": "string"
},
"property2": {"key": "string",
"name": "string"
}
},
"envVars": {"property1": "string",
"property2": "string"
},
"hostAliases": [{"hostnames": ["string"
],
"ip": "string"
}
],
"image": "string",
"instanceSelector": "string",
"instanceAllowList": "string",
"javaOptions": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"sidecars": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"initContainers": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"labels": {"property1": "string",
"property2": "string"
},
"memory": "string",
"memoryOverhead": "string",
"podName": "string",
"podSecurityContext": {"fsGroup": 0,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"supplementalGroups": [0
],
"sysctls": [{"name": "string",
"value": "string"
}
],
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"secrets": [{"name": "string",
"path": "string",
"secretType": "GCPServiceAccount"
}
],
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"spot": true,
"tolerations": [{"effect": "string",
"key": "string",
"operator": "string",
"tolerationSeconds": 0,
"value": "string"
}
],
"vngIds": ["string"
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
]
},
"executor": {"affinity": {"nodeAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"preference": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": {"nodeSelectorTerms": [{"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
}
]
}
},
"podAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
},
"podAntiAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
}
},
"annotations": {"property1": "string",
"property2": "string"
},
"configMaps": [{"name": "string",
"path": "string"
}
],
"coreLimit": "string",
"coreRequest": "string",
"cores": 0,
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envSecretKeyRefs": {"property1": {"key": "string",
"name": "string"
},
"property2": {"key": "string",
"name": "string"
}
},
"envVars": {"property1": "string",
"property2": "string"
},
"hostAliases": [{"hostnames": ["string"
],
"ip": "string"
}
],
"image": "string",
"instanceSelector": "string",
"instanceAllowList": "string",
"sidecars": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"initContainers": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"instances": 0,
"javaOptions": "string",
"labels": {"property1": "string",
"property2": "string"
},
"memory": "string",
"memoryOverhead": "string",
"podSecurityContext": {"fsGroup": 0,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"supplementalGroups": [0
],
"sysctls": [{"name": "string",
"value": "string"
}
],
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"secrets": [{"name": "string",
"path": "string",
"secretType": "GCPServiceAccount"
}
],
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"spot": true,
"tolerations": [{"effect": "string",
"key": "string",
"operator": "string",
"tolerationSeconds": 0,
"value": "string"
}
],
"vngIds": ["string"
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
]
},
"hadoopConf": {"property1": "string",
"property2": "string"
},
"hadoopConfigMap": "string",
"image": "string",
"imagePullPolicy": "string",
"imagePullSecrets": ["string"
],
"initContainerImage": "string",
"mainApplicationFile": "string",
"mainClass": "string",
"memoryOverheadFactor": "string",
"availabilityZone": "string",
"pythonVersion": "3",
"sparkConf": {"property1": "string",
"property2": "string"
},
"sparkConfigMap": "string",
"sparkVersion": "string",
"timeout": "DISABLED",
"timeToLiveSeconds": 0,
"type": "Java",
"volumes": [{"awsElasticBlockStore": {"fsType": "string",
"partition": 0,
"readOnly": true,
"volumeID": "string"
},
"azureDisk": {"cachingMode": "string",
"diskName": "string",
"diskURI": "string",
"fsType": "string",
"kind": "string",
"readOnly": true
},
"azureFile": {"readOnly": true,
"secretName": "string",
"shareName": "string"
},
"cephfs": {"monitors": ["string"
],
"path": "string",
"readOnly": true,
"secretFile": "string",
"secretRef": {"name": "string"
},
"user": "string"
},
"cinder": {"fsType": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"volumeID": "string"
},
"configMap": {"defaultMode": 0,
"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"csi": {"driver": "string",
"fsType": "string",
"nodePublishSecretRef": {"name": "string"
},
"readOnly": true,
"volumeAttributes": {"property1": "string",
"property2": "string"
}
},
"downwardAPI": {"defaultMode": 0,
"items": [{"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"mode": 0,
"path": "string",
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
}
}
]
},
"emptyDir": {"medium": "string",
"sizeLimit": "string"
},
"fc": {"fsType": "string",
"lun": 0,
"readOnly": true,
"targetWWNs": ["string"
],
"wwids": ["string"
]
},
"flexVolume": {"driver": "string",
"fsType": "string",
"options": {"property1": "string",
"property2": "string"
},
"readOnly": true,
"secretRef": {"name": "string"
}
},
"flocker": {"datasetName": "string",
"datasetUUID": "string"
},
"gcePersistentDisk": {"fsType": "string",
"partition": 0,
"pdName": "string",
"readOnly": true
},
"gitRepo": {"directory": "string",
"repository": "string",
"revision": "string"
},
"glusterfs": {"endpoints": "string",
"path": "string",
"readOnly": true
},
"hostPath": {"path": "string",
"type": "string"
},
"iscsi": {"chapAuthDiscovery": true,
"chapAuthSession": true,
"fsType": "string",
"initiatorName": "string",
"iqn": "string",
"iscsiInterface": "string",
"lun": 0,
"portals": ["string"
],
"readOnly": true,
"secretRef": {"name": "string"
},
"targetPortal": "string"
},
"name": "string",
"nfs": {"path": "string",
"readOnly": true,
"server": "string"
},
"persistentVolumeClaim": {"claimName": "string",
"readOnly": true
},
"photonPersistentDisk": {"fsType": "string",
"pdID": "string"
},
"portworxVolume": {"fsType": "string",
"readOnly": true,
"volumeID": "string"
},
"projected": {"defaultMode": 0,
"sources": [{"configMap": {"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"downwardAPI": {"items": [{"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"mode": 0,
"path": "string",
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
}
}
]
},
"secret": {"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"serviceAccountToken": {"audience": "string",
"expirationSeconds": 0,
"path": "string"
}
}
]
},
"quobyte": {"group": "string",
"readOnly": true,
"registry": "string",
"tenant": "string",
"user": "string",
"volume": "string"
},
"rbd": {"fsType": "string",
"image": "string",
"keyring": "string",
"monitors": ["string"
],
"pool": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"user": "string"
},
"scaleIO": {"fsType": "string",
"gateway": "string",
"protectionDomain": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"sslEnabled": true,
"storageMode": "string",
"storagePool": "string",
"system": "string",
"volumeName": "string"
},
"secret": {"defaultMode": 0,
"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"optional": true,
"secretName": "string"
},
"storageos": {"fsType": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"volumeName": "string",
"volumeNamespace": "string"
},
"vsphereVolume": {"fsType": "string",
"storagePolicyID": "string",
"storagePolicyName": "string",
"volumePath": "string"
}
}
]
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-11-01T10:50:29.000+0000",
"id": "large-app",
"displayName": "Large application",
"clusterId": "osc-20fac3f1",
"config": {"arguments": ["string"
],
"deps": {"files": ["string"
],
"jars": ["string"
],
"pyFiles": ["string"
]
},
"driver": {"affinity": {"nodeAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"preference": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": {"nodeSelectorTerms": [{"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
}
]
}
},
"podAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
},
"podAntiAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
}
},
"annotations": {"property1": "string",
"property2": "string"
},
"configMaps": [{"name": "string",
"path": "string"
}
],
"coreLimit": "string",
"coreRequest": "string",
"cores": 0,
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envSecretKeyRefs": {"property1": {"key": "string",
"name": "string"
},
"property2": {"key": "string",
"name": "string"
}
},
"envVars": {"property1": "string",
"property2": "string"
},
"hostAliases": [{"hostnames": ["string"
],
"ip": "string"
}
],
"image": "string",
"instanceSelector": "string",
"instanceAllowList": "string",
"javaOptions": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"sidecars": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"initContainers": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"labels": {"property1": "string",
"property2": "string"
},
"memory": "string",
"memoryOverhead": "string",
"podName": "string",
"podSecurityContext": {"fsGroup": 0,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"supplementalGroups": [0
],
"sysctls": [{"name": "string",
"value": "string"
}
],
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"secrets": [{"name": "string",
"path": "string",
"secretType": "GCPServiceAccount"
}
],
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"spot": true,
"tolerations": [{"effect": "string",
"key": "string",
"operator": "string",
"tolerationSeconds": 0,
"value": "string"
}
],
"vngIds": ["string"
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
]
},
"executor": {"affinity": {"nodeAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"preference": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": {"nodeSelectorTerms": [{"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
}
]
}
},
"podAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
},
"podAntiAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
}
},
"annotations": {"property1": "string",
"property2": "string"
},
"configMaps": [{"name": "string",
"path": "string"
}
],
"coreLimit": "string",
"coreRequest": "string",
"cores": 0,
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envSecretKeyRefs": {"property1": {"key": "string",
"name": "string"
},
"property2": {"key": "string",
"name": "string"
}
},
"envVars": {"property1": "string",
"property2": "string"
},
"hostAliases": [{"hostnames": ["string"
],
"ip": "string"
}
],
"image": "string",
"instanceSelector": "string",
"instanceAllowList": "string",
"sidecars": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"initContainers": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"instances": 0,
"javaOptions": "string",
"labels": {"property1": "string",
"property2": "string"
},
"memory": "string",
"memoryOverhead": "string",
"podSecurityContext": {"fsGroup": 0,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"supplementalGroups": [0
],
"sysctls": [{"name": "string",
"value": "string"
}
],
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"secrets": [{"name": "string",
"path": "string",
"secretType": "GCPServiceAccount"
}
],
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"spot": true,
"tolerations": [{"effect": "string",
"key": "string",
"operator": "string",
"tolerationSeconds": 0,
"value": "string"
}
],
"vngIds": ["string"
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
]
},
"hadoopConf": {"property1": "string",
"property2": "string"
},
"hadoopConfigMap": "string",
"image": "string",
"imagePullPolicy": "string",
"imagePullSecrets": ["string"
],
"initContainerImage": "string",
"mainApplicationFile": "string",
"mainClass": "string",
"memoryOverheadFactor": "string",
"availabilityZone": "string",
"pythonVersion": "3",
"sparkConf": {"property1": "string",
"property2": "string"
},
"sparkConfigMap": "string",
"sparkVersion": "string",
"timeout": "DISABLED",
"timeToLiveSeconds": 0,
"type": "Java",
"volumes": [{"awsElasticBlockStore": {"fsType": "string",
"partition": 0,
"readOnly": true,
"volumeID": "string"
},
"azureDisk": {"cachingMode": "string",
"diskName": "string",
"diskURI": "string",
"fsType": "string",
"kind": "string",
"readOnly": true
},
"azureFile": {"readOnly": true,
"secretName": "string",
"shareName": "string"
},
"cephfs": {"monitors": ["string"
],
"path": "string",
"readOnly": true,
"secretFile": "string",
"secretRef": {"name": "string"
},
"user": "string"
},
"cinder": {"fsType": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"volumeID": "string"
},
"configMap": {"defaultMode": 0,
"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"csi": {"driver": "string",
"fsType": "string",
"nodePublishSecretRef": {"name": "string"
},
"readOnly": true,
"volumeAttributes": {"property1": "string",
"property2": "string"
}
},
"downwardAPI": {"defaultMode": 0,
"items": [{"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"mode": 0,
"path": "string",
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
}
}
]
},
"emptyDir": {"medium": "string",
"sizeLimit": "string"
},
"fc": {"fsType": "string",
"lun": 0,
"readOnly": true,
"targetWWNs": ["string"
],
"wwids": ["string"
]
},
"flexVolume": {"driver": "string",
"fsType": "string",
"options": {"property1": "string",
"property2": "string"
},
"readOnly": true,
"secretRef": {"name": "string"
}
},
"flocker": {"datasetName": "string",
"datasetUUID": "string"
},
"gcePersistentDisk": {"fsType": "string",
"partition": 0,
"pdName": "string",
"readOnly": true
},
"gitRepo": {"directory": "string",
"repository": "string",
"revision": "string"
},
"glusterfs": {"endpoints": "string",
"path": "string",
"readOnly": true
},
"hostPath": {"path": "string",
"type": "string"
},
"iscsi": {"chapAuthDiscovery": true,
"chapAuthSession": true,
"fsType": "string",
"initiatorName": "string",
"iqn": "string",
"iscsiInterface": "string",
"lun": 0,
"portals": ["string"
],
"readOnly": true,
"secretRef": {"name": "string"
},
"targetPortal": "string"
},
"name": "string",
"nfs": {"path": "string",
"readOnly": true,
"server": "string"
},
"persistentVolumeClaim": {"claimName": "string",
"readOnly": true
},
"photonPersistentDisk": {"fsType": "string",
"pdID": "string"
},
"portworxVolume": {"fsType": "string",
"readOnly": true,
"volumeID": "string"
},
"projected": {"defaultMode": 0,
"sources": [{"configMap": {"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"downwardAPI": {"items": [{"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"mode": 0,
"path": "string",
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
}
}
]
},
"secret": {"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"serviceAccountToken": {"audience": "string",
"expirationSeconds": 0,
"path": "string"
}
}
]
},
"quobyte": {"group": "string",
"readOnly": true,
"registry": "string",
"tenant": "string",
"user": "string",
"volume": "string"
},
"rbd": {"fsType": "string",
"image": "string",
"keyring": "string",
"monitors": ["string"
],
"pool": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"user": "string"
},
"scaleIO": {"fsType": "string",
"gateway": "string",
"protectionDomain": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"sslEnabled": true,
"storageMode": "string",
"storagePool": "string",
"system": "string",
"volumeName": "string"
},
"secret": {"defaultMode": 0,
"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"optional": true,
"secretName": "string"
},
"storageos": {"fsType": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"volumeName": "string",
"volumeNamespace": "string"
},
"vsphereVolume": {"fsType": "string",
"storagePolicyID": "string",
"storagePolicyName": "string",
"volumePath": "string"
}
}
]
}
}
],
"count": 1,
"kind": "string"
}
}

Get Config Template

Describe a config template tied to an Ocean Spark cluster.

Authorizations:

path Parameters

clusterId required	string (oceanSparkClusterId) Example: osc-20fac3f1 A unique identifier for the Ocean Spark cluster
configTemplateId required	string (oceanSparkConfigTemplateId) ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a... Example: large-app A unique identifier for a configuration template, set by the user.

query Parameters

accountId

string

Example: accountId=act-123456789

The ID of the account associated with your token. If omitted the oldest account in the organization will be used.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-11-01T10:50:29.000+0000",
"id": "large-app",
"displayName": "Large application",
"clusterId": "osc-20fac3f1",
"config": {"arguments": ["string"
],
"deps": {"files": ["string"
],
"jars": ["string"
],
"pyFiles": ["string"
]
},
"driver": {"affinity": {"nodeAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"preference": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": {"nodeSelectorTerms": [{"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
}
]
}
},
"podAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
},
"podAntiAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
}
},
"annotations": {"property1": "string",
"property2": "string"
},
"configMaps": [{"name": "string",
"path": "string"
}
],
"coreLimit": "string",
"coreRequest": "string",
"cores": 0,
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envSecretKeyRefs": {"property1": {"key": "string",
"name": "string"
},
"property2": {"key": "string",
"name": "string"
}
},
"envVars": {"property1": "string",
"property2": "string"
},
"hostAliases": [{"hostnames": ["string"
],
"ip": "string"
}
],
"image": "string",
"instanceSelector": "string",
"instanceAllowList": "string",
"javaOptions": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"sidecars": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"initContainers": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"labels": {"property1": "string",
"property2": "string"
},
"memory": "string",
"memoryOverhead": "string",
"podName": "string",
"podSecurityContext": {"fsGroup": 0,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"supplementalGroups": [0
],
"sysctls": [{"name": "string",
"value": "string"
}
],
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"secrets": [{"name": "string",
"path": "string",
"secretType": "GCPServiceAccount"
}
],
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"spot": true,
"tolerations": [{"effect": "string",
"key": "string",
"operator": "string",
"tolerationSeconds": 0,
"value": "string"
}
],
"vngIds": ["string"
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
]
},
"executor": {"affinity": {"nodeAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"preference": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": {"nodeSelectorTerms": [{"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
}
]
}
},
"podAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
},
"podAntiAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
}
},
"annotations": {"property1": "string",
"property2": "string"
},
"configMaps": [{"name": "string",
"path": "string"
}
],
"coreLimit": "string",
"coreRequest": "string",
"cores": 0,
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envSecretKeyRefs": {"property1": {"key": "string",
"name": "string"
},
"property2": {"key": "string",
"name": "string"
}
},
"envVars": {"property1": "string",
"property2": "string"
},
"hostAliases": [{"hostnames": ["string"
],
"ip": "string"
}
],
"image": "string",
"instanceSelector": "string",
"instanceAllowList": "string",
"sidecars": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"initContainers": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"instances": 0,
"javaOptions": "string",
"labels": {"property1": "string",
"property2": "string"
},
"memory": "string",
"memoryOverhead": "string",
"podSecurityContext": {"fsGroup": 0,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"supplementalGroups": [0
],
"sysctls": [{"name": "string",
"value": "string"
}
],
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"secrets": [{"name": "string",
"path": "string",
"secretType": "GCPServiceAccount"
}
],
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"spot": true,
"tolerations": [{"effect": "string",
"key": "string",
"operator": "string",
"tolerationSeconds": 0,
"value": "string"
}
],
"vngIds": ["string"
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
]
},
"hadoopConf": {"property1": "string",
"property2": "string"
},
"hadoopConfigMap": "string",
"image": "string",
"imagePullPolicy": "string",
"imagePullSecrets": ["string"
],
"initContainerImage": "string",
"mainApplicationFile": "string",
"mainClass": "string",
"memoryOverheadFactor": "string",
"availabilityZone": "string",
"pythonVersion": "3",
"sparkConf": {"property1": "string",
"property2": "string"
},
"sparkConfigMap": "string",
"sparkVersion": "string",
"timeout": "DISABLED",
"timeToLiveSeconds": 0,
"type": "Java",
"volumes": [{"awsElasticBlockStore": {"fsType": "string",
"partition": 0,
"readOnly": true,
"volumeID": "string"
},
"azureDisk": {"cachingMode": "string",
"diskName": "string",
"diskURI": "string",
"fsType": "string",
"kind": "string",
"readOnly": true
},
"azureFile": {"readOnly": true,
"secretName": "string",
"shareName": "string"
},
"cephfs": {"monitors": ["string"
],
"path": "string",
"readOnly": true,
"secretFile": "string",
"secretRef": {"name": "string"
},
"user": "string"
},
"cinder": {"fsType": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"volumeID": "string"
},
"configMap": {"defaultMode": 0,
"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"csi": {"driver": "string",
"fsType": "string",
"nodePublishSecretRef": {"name": "string"
},
"readOnly": true,
"volumeAttributes": {"property1": "string",
"property2": "string"
}
},
"downwardAPI": {"defaultMode": 0,
"items": [{"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"mode": 0,
"path": "string",
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
}
}
]
},
"emptyDir": {"medium": "string",
"sizeLimit": "string"
},
"fc": {"fsType": "string",
"lun": 0,
"readOnly": true,
"targetWWNs": ["string"
],
"wwids": ["string"
]
},
"flexVolume": {"driver": "string",
"fsType": "string",
"options": {"property1": "string",
"property2": "string"
},
"readOnly": true,
"secretRef": {"name": "string"
}
},
"flocker": {"datasetName": "string",
"datasetUUID": "string"
},
"gcePersistentDisk": {"fsType": "string",
"partition": 0,
"pdName": "string",
"readOnly": true
},
"gitRepo": {"directory": "string",
"repository": "string",
"revision": "string"
},
"glusterfs": {"endpoints": "string",
"path": "string",
"readOnly": true
},
"hostPath": {"path": "string",
"type": "string"
},
"iscsi": {"chapAuthDiscovery": true,
"chapAuthSession": true,
"fsType": "string",
"initiatorName": "string",
"iqn": "string",
"iscsiInterface": "string",
"lun": 0,
"portals": ["string"
],
"readOnly": true,
"secretRef": {"name": "string"
},
"targetPortal": "string"
},
"name": "string",
"nfs": {"path": "string",
"readOnly": true,
"server": "string"
},
"persistentVolumeClaim": {"claimName": "string",
"readOnly": true
},
"photonPersistentDisk": {"fsType": "string",
"pdID": "string"
},
"portworxVolume": {"fsType": "string",
"readOnly": true,
"volumeID": "string"
},
"projected": {"defaultMode": 0,
"sources": [{"configMap": {"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"downwardAPI": {"items": [{"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"mode": 0,
"path": "string",
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
}
}
]
},
"secret": {"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"serviceAccountToken": {"audience": "string",
"expirationSeconds": 0,
"path": "string"
}
}
]
},
"quobyte": {"group": "string",
"readOnly": true,
"registry": "string",
"tenant": "string",
"user": "string",
"volume": "string"
},
"rbd": {"fsType": "string",
"image": "string",
"keyring": "string",
"monitors": ["string"
],
"pool": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"user": "string"
},
"scaleIO": {"fsType": "string",
"gateway": "string",
"protectionDomain": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"sslEnabled": true,
"storageMode": "string",
"storagePool": "string",
"system": "string",
"volumeName": "string"
},
"secret": {"defaultMode": 0,
"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"optional": true,
"secretName": "string"
},
"storageos": {"fsType": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"volumeName": "string",
"volumeNamespace": "string"
},
"vsphereVolume": {"fsType": "string",
"storagePolicyID": "string",
"storagePolicyName": "string",
"volumePath": "string"
}
}
]
}
}
],
"count": 1,
"kind": "string"
}
}

Put Config Template

Update a config template by replacing the existing configuration with the one provided in the request body.

Authorizations:

path Parameters

clusterId required	string (oceanSparkClusterId) Example: osc-20fac3f1 A unique identifier for the Ocean Spark cluster
configTemplateId required	string (oceanSparkConfigTemplateId) ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a... Example: large-app A unique identifier for a configuration template, set by the user.

query Parameters

accountId

string

Example: accountId=act-123456789

The ID of the account associated with your token. If omitted the oldest account in the organization will be used.

Request Body schema: application/json

	object The piece of configuration that will replace the existing configuration
displayName	string (oceanSparkConfigTemplateDisplayName) A non-unique free-form name for the config template used in the Spot console. Defaults to the config template ID.

Responses

Request samples

Payload

Content type

application/json

{"displayName": "Large application",
"config": {"arguments": ["string"
],
"deps": {"files": ["string"
],
"jars": ["string"
],
"pyFiles": ["string"
]
},
"driver": {"affinity": {"nodeAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"preference": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": {"nodeSelectorTerms": [{"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
}
]
}
},
"podAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
},
"podAntiAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
}
},
"annotations": {"property1": "string",
"property2": "string"
},
"configMaps": [{"name": "string",
"path": "string"
}
],
"coreLimit": "string",
"coreRequest": "string",
"cores": 0,
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envSecretKeyRefs": {"property1": {"key": "string",
"name": "string"
},
"property2": {"key": "string",
"name": "string"
}
},
"envVars": {"property1": "string",
"property2": "string"
},
"hostAliases": [{"hostnames": ["string"
],
"ip": "string"
}
],
"image": "string",
"instanceSelector": "string",
"instanceAllowList": "string",
"javaOptions": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"sidecars": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"initContainers": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"labels": {"property1": "string",
"property2": "string"
},
"memory": "string",
"memoryOverhead": "string",
"podName": "string",
"podSecurityContext": {"fsGroup": 0,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"supplementalGroups": [0
],
"sysctls": [{"name": "string",
"value": "string"
}
],
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"secrets": [{"name": "string",
"path": "string",
"secretType": "GCPServiceAccount"
}
],
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"spot": true,
"tolerations": [{"effect": "string",
"key": "string",
"operator": "string",
"tolerationSeconds": 0,
"value": "string"
}
],
"vngIds": ["string"
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
]
},
"executor": {"affinity": {"nodeAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"preference": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": {"nodeSelectorTerms": [{"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
}
]
}
},
"podAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
},
"podAntiAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
}
},
"annotations": {"property1": "string",
"property2": "string"
},
"configMaps": [{"name": "string",
"path": "string"
}
],
"coreLimit": "string",
"coreRequest": "string",
"cores": 0,
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envSecretKeyRefs": {"property1": {"key": "string",
"name": "string"
},
"property2": {"key": "string",
"name": "string"
}
},
"envVars": {"property1": "string",
"property2": "string"
},
"hostAliases": [{"hostnames": ["string"
],
"ip": "string"
}
],
"image": "string",
"instanceSelector": "string",
"instanceAllowList": "string",
"sidecars": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"initContainers": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"instances": 0,
"javaOptions": "string",
"labels": {"property1": "string",
"property2": "string"
},
"memory": "string",
"memoryOverhead": "string",
"podSecurityContext": {"fsGroup": 0,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"supplementalGroups": [0
],
"sysctls": [{"name": "string",
"value": "string"
}
],
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"secrets": [{"name": "string",
"path": "string",
"secretType": "GCPServiceAccount"
}
],
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"spot": true,
"tolerations": [{"effect": "string",
"key": "string",
"operator": "string",
"tolerationSeconds": 0,
"value": "string"
}
],
"vngIds": ["string"
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
]
},
"hadoopConf": {"property1": "string",
"property2": "string"
},
"hadoopConfigMap": "string",
"image": "string",
"imagePullPolicy": "string",
"imagePullSecrets": ["string"
],
"initContainerImage": "string",
"mainApplicationFile": "string",
"mainClass": "string",
"memoryOverheadFactor": "string",
"availabilityZone": "string",
"pythonVersion": "3",
"sparkConf": {"property1": "string",
"property2": "string"
},
"sparkConfigMap": "string",
"sparkVersion": "string",
"timeout": "DISABLED",
"timeToLiveSeconds": 0,
"type": "Java",
"volumes": [{"awsElasticBlockStore": {"fsType": "string",
"partition": 0,
"readOnly": true,
"volumeID": "string"
},
"azureDisk": {"cachingMode": "string",
"diskName": "string",
"diskURI": "string",
"fsType": "string",
"kind": "string",
"readOnly": true
},
"azureFile": {"readOnly": true,
"secretName": "string",
"shareName": "string"
},
"cephfs": {"monitors": ["string"
],
"path": "string",
"readOnly": true,
"secretFile": "string",
"secretRef": {"name": "string"
},
"user": "string"
},
"cinder": {"fsType": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"volumeID": "string"
},
"configMap": {"defaultMode": 0,
"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"csi": {"driver": "string",
"fsType": "string",
"nodePublishSecretRef": {"name": "string"
},
"readOnly": true,
"volumeAttributes": {"property1": "string",
"property2": "string"
}
},
"downwardAPI": {"defaultMode": 0,
"items": [{"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"mode": 0,
"path": "string",
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
}
}
]
},
"emptyDir": {"medium": "string",
"sizeLimit": "string"
},
"fc": {"fsType": "string",
"lun": 0,
"readOnly": true,
"targetWWNs": ["string"
],
"wwids": ["string"
]
},
"flexVolume": {"driver": "string",
"fsType": "string",
"options": {"property1": "string",
"property2": "string"
},
"readOnly": true,
"secretRef": {"name": "string"
}
},
"flocker": {"datasetName": "string",
"datasetUUID": "string"
},
"gcePersistentDisk": {"fsType": "string",
"partition": 0,
"pdName": "string",
"readOnly": true
},
"gitRepo": {"directory": "string",
"repository": "string",
"revision": "string"
},
"glusterfs": {"endpoints": "string",
"path": "string",
"readOnly": true
},
"hostPath": {"path": "string",
"type": "string"
},
"iscsi": {"chapAuthDiscovery": true,
"chapAuthSession": true,
"fsType": "string",
"initiatorName": "string",
"iqn": "string",
"iscsiInterface": "string",
"lun": 0,
"portals": ["string"
],
"readOnly": true,
"secretRef": {"name": "string"
},
"targetPortal": "string"
},
"name": "string",
"nfs": {"path": "string",
"readOnly": true,
"server": "string"
},
"persistentVolumeClaim": {"claimName": "string",
"readOnly": true
},
"photonPersistentDisk": {"fsType": "string",
"pdID": "string"
},
"portworxVolume": {"fsType": "string",
"readOnly": true,
"volumeID": "string"
},
"projected": {"defaultMode": 0,
"sources": [{"configMap": {"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"downwardAPI": {"items": [{"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"mode": 0,
"path": "string",
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
}
}
]
},
"secret": {"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"serviceAccountToken": {"audience": "string",
"expirationSeconds": 0,
"path": "string"
}
}
]
},
"quobyte": {"group": "string",
"readOnly": true,
"registry": "string",
"tenant": "string",
"user": "string",
"volume": "string"
},
"rbd": {"fsType": "string",
"image": "string",
"keyring": "string",
"monitors": ["string"
],
"pool": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"user": "string"
},
"scaleIO": {"fsType": "string",
"gateway": "string",
"protectionDomain": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"sslEnabled": true,
"storageMode": "string",
"storagePool": "string",
"system": "string",
"volumeName": "string"
},
"secret": {"defaultMode": 0,
"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"optional": true,
"secretName": "string"
},
"storageos": {"fsType": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"volumeName": "string",
"volumeNamespace": "string"
},
"vsphereVolume": {"fsType": "string",
"storagePolicyID": "string",
"storagePolicyName": "string",
"volumePath": "string"
}
}
]
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-11-01T10:50:29.000+0000",
"id": "large-app",
"displayName": "Large application",
"clusterId": "osc-20fac3f1",
"config": {"arguments": ["string"
],
"deps": {"files": ["string"
],
"jars": ["string"
],
"pyFiles": ["string"
]
},
"driver": {"affinity": {"nodeAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"preference": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": {"nodeSelectorTerms": [{"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
}
]
}
},
"podAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
},
"podAntiAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
}
},
"annotations": {"property1": "string",
"property2": "string"
},
"configMaps": [{"name": "string",
"path": "string"
}
],
"coreLimit": "string",
"coreRequest": "string",
"cores": 0,
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envSecretKeyRefs": {"property1": {"key": "string",
"name": "string"
},
"property2": {"key": "string",
"name": "string"
}
},
"envVars": {"property1": "string",
"property2": "string"
},
"hostAliases": [{"hostnames": ["string"
],
"ip": "string"
}
],
"image": "string",
"instanceSelector": "string",
"instanceAllowList": "string",
"javaOptions": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"sidecars": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"initContainers": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"labels": {"property1": "string",
"property2": "string"
},
"memory": "string",
"memoryOverhead": "string",
"podName": "string",
"podSecurityContext": {"fsGroup": 0,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"supplementalGroups": [0
],
"sysctls": [{"name": "string",
"value": "string"
}
],
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"secrets": [{"name": "string",
"path": "string",
"secretType": "GCPServiceAccount"
}
],
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"spot": true,
"tolerations": [{"effect": "string",
"key": "string",
"operator": "string",
"tolerationSeconds": 0,
"value": "string"
}
],
"vngIds": ["string"
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
]
},
"executor": {"affinity": {"nodeAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"preference": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": {"nodeSelectorTerms": [{"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
}
]
}
},
"podAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
},
"podAntiAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
}
},
"annotations": {"property1": "string",
"property2": "string"
},
"configMaps": [{"name": "string",
"path": "string"
}
],
"coreLimit": "string",
"coreRequest": "string",
"cores": 0,
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envSecretKeyRefs": {"property1": {"key": "string",
"name": "string"
},
"property2": {"key": "string",
"name": "string"
}
},
"envVars": {"property1": "string",
"property2": "string"
},
"hostAliases": [{"hostnames": ["string"
],
"ip": "string"
}
],
"image": "string",
"instanceSelector": "string",
"instanceAllowList": "string",
"sidecars": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"initContainers": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"instances": 0,
"javaOptions": "string",
"labels": {"property1": "string",
"property2": "string"
},
"memory": "string",
"memoryOverhead": "string",
"podSecurityContext": {"fsGroup": 0,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"supplementalGroups": [0
],
"sysctls": [{"name": "string",
"value": "string"
}
],
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"secrets": [{"name": "string",
"path": "string",
"secretType": "GCPServiceAccount"
}
],
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"spot": true,
"tolerations": [{"effect": "string",
"key": "string",
"operator": "string",
"tolerationSeconds": 0,
"value": "string"
}
],
"vngIds": ["string"
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
]
},
"hadoopConf": {"property1": "string",
"property2": "string"
},
"hadoopConfigMap": "string",
"image": "string",
"imagePullPolicy": "string",
"imagePullSecrets": ["string"
],
"initContainerImage": "string",
"mainApplicationFile": "string",
"mainClass": "string",
"memoryOverheadFactor": "string",
"availabilityZone": "string",
"pythonVersion": "3",
"sparkConf": {"property1": "string",
"property2": "string"
},
"sparkConfigMap": "string",
"sparkVersion": "string",
"timeout": "DISABLED",
"timeToLiveSeconds": 0,
"type": "Java",
"volumes": [{"awsElasticBlockStore": {"fsType": "string",
"partition": 0,
"readOnly": true,
"volumeID": "string"
},
"azureDisk": {"cachingMode": "string",
"diskName": "string",
"diskURI": "string",
"fsType": "string",
"kind": "string",
"readOnly": true
},
"azureFile": {"readOnly": true,
"secretName": "string",
"shareName": "string"
},
"cephfs": {"monitors": ["string"
],
"path": "string",
"readOnly": true,
"secretFile": "string",
"secretRef": {"name": "string"
},
"user": "string"
},
"cinder": {"fsType": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"volumeID": "string"
},
"configMap": {"defaultMode": 0,
"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"csi": {"driver": "string",
"fsType": "string",
"nodePublishSecretRef": {"name": "string"
},
"readOnly": true,
"volumeAttributes": {"property1": "string",
"property2": "string"
}
},
"downwardAPI": {"defaultMode": 0,
"items": [{"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"mode": 0,
"path": "string",
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
}
}
]
},
"emptyDir": {"medium": "string",
"sizeLimit": "string"
},
"fc": {"fsType": "string",
"lun": 0,
"readOnly": true,
"targetWWNs": ["string"
],
"wwids": ["string"
]
},
"flexVolume": {"driver": "string",
"fsType": "string",
"options": {"property1": "string",
"property2": "string"
},
"readOnly": true,
"secretRef": {"name": "string"
}
},
"flocker": {"datasetName": "string",
"datasetUUID": "string"
},
"gcePersistentDisk": {"fsType": "string",
"partition": 0,
"pdName": "string",
"readOnly": true
},
"gitRepo": {"directory": "string",
"repository": "string",
"revision": "string"
},
"glusterfs": {"endpoints": "string",
"path": "string",
"readOnly": true
},
"hostPath": {"path": "string",
"type": "string"
},
"iscsi": {"chapAuthDiscovery": true,
"chapAuthSession": true,
"fsType": "string",
"initiatorName": "string",
"iqn": "string",
"iscsiInterface": "string",
"lun": 0,
"portals": ["string"
],
"readOnly": true,
"secretRef": {"name": "string"
},
"targetPortal": "string"
},
"name": "string",
"nfs": {"path": "string",
"readOnly": true,
"server": "string"
},
"persistentVolumeClaim": {"claimName": "string",
"readOnly": true
},
"photonPersistentDisk": {"fsType": "string",
"pdID": "string"
},
"portworxVolume": {"fsType": "string",
"readOnly": true,
"volumeID": "string"
},
"projected": {"defaultMode": 0,
"sources": [{"configMap": {"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"downwardAPI": {"items": [{"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"mode": 0,
"path": "string",
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
}
}
]
},
"secret": {"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"serviceAccountToken": {"audience": "string",
"expirationSeconds": 0,
"path": "string"
}
}
]
},
"quobyte": {"group": "string",
"readOnly": true,
"registry": "string",
"tenant": "string",
"user": "string",
"volume": "string"
},
"rbd": {"fsType": "string",
"image": "string",
"keyring": "string",
"monitors": ["string"
],
"pool": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"user": "string"
},
"scaleIO": {"fsType": "string",
"gateway": "string",
"protectionDomain": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"sslEnabled": true,
"storageMode": "string",
"storagePool": "string",
"system": "string",
"volumeName": "string"
},
"secret": {"defaultMode": 0,
"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"optional": true,
"secretName": "string"
},
"storageos": {"fsType": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"volumeName": "string",
"volumeNamespace": "string"
},
"vsphereVolume": {"fsType": "string",
"storagePolicyID": "string",
"storagePolicyName": "string",
"volumePath": "string"
}
}
]
}
}
],
"count": 1,
"kind": "string"
}
}

Delete Config Template

Delete a config template.

Authorizations:

path Parameters

clusterId required	string (oceanSparkClusterId) Example: osc-20fac3f1 A unique identifier for the Ocean Spark cluster
configTemplateId required	string (oceanSparkConfigTemplateId) ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a... Example: large-app A unique identifier for a configuration template, set by the user.

query Parameters

accountId

string

Example: accountId=act-123456789

The ID of the account associated with your token. If omitted the oldest account in the organization will be used.

Responses

List Jobs

List jobs on all Ocean Spark clusters in the specified account.

Authorizations:

query Parameters

accountId

string

Example: accountId=act-123456789

The ID of the account associated with your token. If omitted the oldest account in the organization will be used.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"internalId": "fa61bb92-4bb7-49aa-87d3-7823bd263d1e",
"id": "daily-reporting",
"displayName": "Daily Reporting",
"controllerClusterId": "my-ocean-cluster",
"clusterId": "osc-20fac3f1",
"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-10-10T10:50:29.000+0000",
"lastApp": {"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-11-01T10:50:29.000+0000",
"internalId": "fa61bb92-4bb7-49aa-87d3-7823bd263d1e",
"id": "daily-reporting-2021-08-18",
"displayName": "Daily Reporting 2021-08-18",
"userId": 59438,
"clusterId": "osc-20fac3f1",
"controllerClusterId": "my-ocean-cluster",
"appState": "RUNNING",
"submissionSource": "public-api",
"job": {"id": "daily-reporting",
"displayName": "Daily Reporting"
},
"config": {"arguments": ["string"
],
"deps": {"files": ["string"
],
"jars": ["string"
],
"pyFiles": ["string"
]
},
"driver": {"affinity": {"nodeAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"preference": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": {"nodeSelectorTerms": [{"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
}
]
}
},
"podAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
},
"podAntiAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
}
},
"annotations": {"property1": "string",
"property2": "string"
},
"configMaps": [{"name": "string",
"path": "string"
}
],
"coreLimit": "string",
"coreRequest": "string",
"cores": 0,
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envSecretKeyRefs": {"property1": {"key": "string",
"name": "string"
},
"property2": {"key": "string",
"name": "string"
}
},
"envVars": {"property1": "string",
"property2": "string"
},
"hostAliases": [{"hostnames": ["string"
],
"ip": "string"
}
],
"image": "string",
"instanceSelector": "string",
"instanceAllowList": "string",
"javaOptions": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"sidecars": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"initContainers": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"labels": {"property1": "string",
"property2": "string"
},
"memory": "string",
"memoryOverhead": "string",
"podName": "string",
"podSecurityContext": {"fsGroup": 0,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"supplementalGroups": [0
],
"sysctls": [{"name": "string",
"value": "string"
}
],
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"secrets": [{"name": "string",
"path": "string",
"secretType": "GCPServiceAccount"
}
],
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"spot": true,
"tolerations": [{"effect": "string",
"key": "string",
"operator": "string",
"tolerationSeconds": 0,
"value": "string"
}
],
"vngIds": ["string"
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
]
},
"executor": {"affinity": {"nodeAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"preference": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": {"nodeSelectorTerms": [{"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
}
]
}
},
"podAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
},
"podAntiAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
}
},
"annotations": {"property1": "string",
"property2": "string"
},
"configMaps": [{"name": "string",
"path": "string"
}
],
"coreLimit": "string",
"coreRequest": "string",
"cores": 0,
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envSecretKeyRefs": {"property1": {"key": "string",
"name": "string"
},
"property2": {"key": "string",
"name": "string"
}
},
"envVars": {"property1": "string",
"property2": "string"
},
"hostAliases": [{"hostnames": ["string"
],
"ip": "string"
}
],
"image": "string",
"instanceSelector": "string",
"instanceAllowList": "string",
"sidecars": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"initContainers": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"instances": 0,
"javaOptions": "string",
"labels": {"property1": "string",
"property2": "string"
},
"memory": "string",
"memoryOverhead": "string",
"podSecurityContext": {"fsGroup": 0,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"supplementalGroups": [0
],
"sysctls": [{"name": "string",
"value": "string"
}
],
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"secrets": [{"name": "string",
"path": "string",
"secretType": "GCPServiceAccount"
}
],
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"spot": true,
"tolerations": [{"effect": "string",
"key": "string",
"operator": "string",
"tolerationSeconds": 0,
"value": "string"
}
],
"vngIds": ["string"
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
]
},
"hadoopConf": {"property1": "string",
"property2": "string"
},
"hadoopConfigMap": "string",
"image": "string",
"imagePullPolicy": "string",
"imagePullSecrets": ["string"
],
"initContainerImage": "string",
"mainApplicationFile": "string",
"mainClass": "string",
"memoryOverheadFactor": "string",
"availabilityZone": "string",
"pythonVersion": "3",
"sparkConf": {"property1": "string",
"property2": "string"
},
"sparkConfigMap": "string",
"sparkVersion": "string",
"timeout": "DISABLED",
"timeToLiveSeconds": 0,
"type": "Java",
"volumes": [{"awsElasticBlockStore": {"fsType": "string",
"partition": 0,
"readOnly": true,
"volumeID": "string"
},
"azureDisk": {"cachingMode": "string",
"diskName": "string",
"diskURI": "string",
"fsType": "string",
"kind": "string",
"readOnly": true
},
"azureFile": {"readOnly": true,
"secretName": "string",
"shareName": "string"
},
"cephfs": {"monitors": ["string"
],
"path": "string",
"readOnly": true,
"secretFile": "string",
"secretRef": {"name": "string"
},
"user": "string"
},
"cinder": {"fsType": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"volumeID": "string"
},
"configMap": {"defaultMode": 0,
"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"csi": {"driver": "string",
"fsType": "string",
"nodePublishSecretRef": {"name": "string"
},
"readOnly": true,
"volumeAttributes": {"property1": "string",
"property2": "string"
}
},
"downwardAPI": {"defaultMode": 0,
"items": [{"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"mode": 0,
"path": "string",
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
}
}
]
},
"emptyDir": {"medium": "string",
"sizeLimit": "string"
},
"fc": {"fsType": "string",
"lun": 0,
"readOnly": true,
"targetWWNs": ["string"
],
"wwids": ["string"
]
},
"flexVolume": {"driver": "string",
"fsType": "string",
"options": {"property1": "string",
"property2": "string"
},
"readOnly": true,
"secretRef": {"name": "string"
}
},
"flocker": {"datasetName": "string",
"datasetUUID": "string"
},
"gcePersistentDisk": {"fsType": "string",
"partition": 0,
"pdName": "string",
"readOnly": true
},
"gitRepo": {"directory": "string",
"repository": "string",
"revision": "string"
},
"glusterfs": {"endpoints": "string",
"path": "string",
"readOnly": true
},
"hostPath": {"path": "string",
"type": "string"
},
"iscsi": {"chapAuthDiscovery": true,
"chapAuthSession": true,
"fsType": "string",
"initiatorName": "string",
"iqn": "string",
"iscsiInterface": "string",
"lun": 0,
"portals": ["string"
],
"readOnly": true,
"secretRef": {"name": "string"
},
"targetPortal": "string"
},
"name": "string",
"nfs": {"path": "string",
"readOnly": true,
"server": "string"
},
"persistentVolumeClaim": {"claimName": "string",
"readOnly": true
},
"photonPersistentDisk": {"fsType": "string",
"pdID": "string"
},
"portworxVolume": {"fsType": "string",
"readOnly": true,
"volumeID": "string"
},
"projected": {"defaultMode": 0,
"sources": [{"configMap": {"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"downwardAPI": {"items": [{"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"mode": 0,
"path": "string",
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
}
}
]
},
"secret": {"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"serviceAccountToken": {"audience": "string",
"expirationSeconds": 0,
"path": "string"
}
}
]
},
"quobyte": {"group": "string",
"readOnly": true,
"registry": "string",
"tenant": "string",
"user": "string",
"volume": "string"
},
"rbd": {"fsType": "string",
"image": "string",
"keyring": "string",
"monitors": ["string"
],
"pool": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"user": "string"
},
"scaleIO": {"fsType": "string",
"gateway": "string",
"protectionDomain": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"sslEnabled": true,
"storageMode": "string",
"storagePool": "string",
"system": "string",
"volumeName": "string"
},
"secret": {"defaultMode": 0,
"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"optional": true,
"secretName": "string"
},
"storageos": {"fsType": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"volumeName": "string",
"volumeNamespace": "string"
},
"vsphereVolume": {"fsType": "string",
"storagePolicyID": "string",
"storagePolicyName": "string",
"volumePath": "string"
}
}
]
},
"startedAt": "2021-11-18T17:09:37+00:00",
"endedAt": "2021-11-18T17:09:37+00:00",
"log": {"logsStreamUrl": "/ocean/spark/cluster/osc-20fac3f1/app/daily-reporting-2021-08-18/logs/live",
"kubeEventsStreamUrl": "/ocean/spark/cluster/osc-20fac3f1/app/daily-reporting-2021-08-18/kubeEvents/live"
},
"metrics": {"cost": {"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-10-10T10:50:29.000+0000",
"total": 0
},
"spark": {"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-10-10T10:50:29.000+0000",
"sparkCoresDurationSeconds": 0,
"inputDataBytes": 0,
"outputDataBytes": 0,
"durationSeconds": 0,
"efficiencyPercent": 0
}
}
},
"history": [{"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-11-01T10:50:29.000+0000",
"internalId": "fa61bb92-4bb7-49aa-87d3-7823bd263d1e",
"id": "daily-reporting-2021-08-18",
"displayName": "Daily Reporting 2021-08-18",
"userId": 59438,
"clusterId": "osc-20fac3f1",
"controllerClusterId": "my-ocean-cluster",
"appState": "RUNNING",
"submissionSource": "public-api",
"job": {"id": "daily-reporting",
"displayName": "Daily Reporting"
},
"config": {"arguments": ["string"
],
"deps": {"files": ["string"
],
"jars": ["string"
],
"pyFiles": ["string"
]
},
"driver": {"affinity": {"nodeAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"preference": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": {"nodeSelectorTerms": [{"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
}
]
}
},
"podAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
},
"podAntiAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
}
},
"annotations": {"property1": "string",
"property2": "string"
},
"configMaps": [{"name": "string",
"path": "string"
}
],
"coreLimit": "string",
"coreRequest": "string",
"cores": 0,
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envSecretKeyRefs": {"property1": {"key": "string",
"name": "string"
},
"property2": {"key": "string",
"name": "string"
}
},
"envVars": {"property1": "string",
"property2": "string"
},
"hostAliases": [{"hostnames": ["string"
],
"ip": "string"
}
],
"image": "string",
"instanceSelector": "string",
"instanceAllowList": "string",
"javaOptions": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"sidecars": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"initContainers": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"labels": {"property1": "string",
"property2": "string"
},
"memory": "string",
"memoryOverhead": "string",
"podName": "string",
"podSecurityContext": {"fsGroup": 0,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"supplementalGroups": [0
],
"sysctls": [{"name": "string",
"value": "string"
}
],
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"secrets": [{"name": "string",
"path": "string",
"secretType": "GCPServiceAccount"
}
],
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"spot": true,
"tolerations": [{"effect": "string",
"key": "string",
"operator": "string",
"tolerationSeconds": 0,
"value": "string"
}
],
"vngIds": ["string"
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
]
},
"executor": {"affinity": {"nodeAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"preference": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": {"nodeSelectorTerms": [{"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
}
]
}
},
"podAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
},
"podAntiAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
}
},
"annotations": {"property1": "string",
"property2": "string"
},
"configMaps": [{"name": "string",
"path": "string"
}
],
"coreLimit": "string",
"coreRequest": "string",
"cores": 0,
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envSecretKeyRefs": {"property1": {"key": "string",
"name": "string"
},
"property2": {"key": "string",
"name": "string"
}
},
"envVars": {"property1": "string",
"property2": "string"
},
"hostAliases": [{"hostnames": ["string"
],
"ip": "string"
}
],
"image": "string",
"instanceSelector": "string",
"instanceAllowList": "string",
"sidecars": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"initContainers": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"instances": 0,
"javaOptions": "string",
"labels": {"property1": "string",
"property2": "string"
},
"memory": "string",
"memoryOverhead": "string",
"podSecurityContext": {"fsGroup": 0,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"supplementalGroups": [0
],
"sysctls": [{"name": "string",
"value": "string"
}
],
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"secrets": [{"name": "string",
"path": "string",
"secretType": "GCPServiceAccount"
}
],
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"spot": true,
"tolerations": [{"effect": "string",
"key": "string",
"operator": "string",
"tolerationSeconds": 0,
"value": "string"
}
],
"vngIds": ["string"
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
]
},
"hadoopConf": {"property1": "string",
"property2": "string"
},
"hadoopConfigMap": "string",
"image": "string",
"imagePullPolicy": "string",
"imagePullSecrets": ["string"
],
"initContainerImage": "string",
"mainApplicationFile": "string",
"mainClass": "string",
"memoryOverheadFactor": "string",
"availabilityZone": "string",
"pythonVersion": "3",
"sparkConf": {"property1": "string",
"property2": "string"
},
"sparkConfigMap": "string",
"sparkVersion": "string",
"timeout": "DISABLED",
"timeToLiveSeconds": 0,
"type": "Java",
"volumes": [{"awsElasticBlockStore": {"fsType": "string",
"partition": 0,
"readOnly": true,
"volumeID": "string"
},
"azureDisk": {"cachingMode": "string",
"diskName": "string",
"diskURI": "string",
"fsType": "string",
"kind": "string",
"readOnly": true
},
"azureFile": {"readOnly": true,
"secretName": "string",
"shareName": "string"
},
"cephfs": {"monitors": ["string"
],
"path": "string",
"readOnly": true,
"secretFile": "string",
"secretRef": {"name": "string"
},
"user": "string"
},
"cinder": {"fsType": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"volumeID": "string"
},
"configMap": {"defaultMode": 0,
"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"csi": {"driver": "string",
"fsType": "string",
"nodePublishSecretRef": {"name": "string"
},
"readOnly": true,
"volumeAttributes": {"property1": "string",
"property2": "string"
}
},
"downwardAPI": {"defaultMode": 0,
"items": [{"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"mode": 0,
"path": "string",
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
}
}
]
},
"emptyDir": {"medium": "string",
"sizeLimit": "string"
},
"fc": {"fsType": "string",
"lun": 0,
"readOnly": true,
"targetWWNs": ["string"
],
"wwids": ["string"
]
},
"flexVolume": {"driver": "string",
"fsType": "string",
"options": {"property1": "string",
"property2": "string"
},
"readOnly": true,
"secretRef": {"name": "string"
}
},
"flocker": {"datasetName": "string",
"datasetUUID": "string"
},
"gcePersistentDisk": {"fsType": "string",
"partition": 0,
"pdName": "string",
"readOnly": true
},
"gitRepo": {"directory": "string",
"repository": "string",
"revision": "string"
},
"glusterfs": {"endpoints": "string",
"path": "string",
"readOnly": true
},
"hostPath": {"path": "string",
"type": "string"
},
"iscsi": {"chapAuthDiscovery": true,
"chapAuthSession": true,
"fsType": "string",
"initiatorName": "string",
"iqn": "string",
"iscsiInterface": "string",
"lun": 0,
"portals": ["string"
],
"readOnly": true,
"secretRef": {"name": "string"
},
"targetPortal": "string"
},
"name": "string",
"nfs": {"path": "string",
"readOnly": true,
"server": "string"
},
"persistentVolumeClaim": {"claimName": "string",
"readOnly": true
},
"photonPersistentDisk": {"fsType": "string",
"pdID": "string"
},
"portworxVolume": {"fsType": "string",
"readOnly": true,
"volumeID": "string"
},
"projected": {"defaultMode": 0,
"sources": [{"configMap": {"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"downwardAPI": {"items": [{"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"mode": 0,
"path": "string",
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
}
}
]
},
"secret": {"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"serviceAccountToken": {"audience": "string",
"expirationSeconds": 0,
"path": "string"
}
}
]
},
"quobyte": {"group": "string",
"readOnly": true,
"registry": "string",
"tenant": "string",
"user": "string",
"volume": "string"
},
"rbd": {"fsType": "string",
"image": "string",
"keyring": "string",
"monitors": ["string"
],
"pool": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"user": "string"
},
"scaleIO": {"fsType": "string",
"gateway": "string",
"protectionDomain": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"sslEnabled": true,
"storageMode": "string",
"storagePool": "string",
"system": "string",
"volumeName": "string"
},
"secret": {"defaultMode": 0,
"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"optional": true,
"secretName": "string"
},
"storageos": {"fsType": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"volumeName": "string",
"volumeNamespace": "string"
},
"vsphereVolume": {"fsType": "string",
"storagePolicyID": "string",
"storagePolicyName": "string",
"volumePath": "string"
}
}
]
},
"startedAt": "2021-11-18T17:09:37+00:00",
"endedAt": "2021-11-18T17:09:37+00:00",
"log": {"logsStreamUrl": "/ocean/spark/cluster/osc-20fac3f1/app/daily-reporting-2021-08-18/logs/live",
"kubeEventsStreamUrl": "/ocean/spark/cluster/osc-20fac3f1/app/daily-reporting-2021-08-18/kubeEvents/live"
},
"metrics": {"cost": {"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-10-10T10:50:29.000+0000",
"total": 0
},
"spark": {"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-10-10T10:50:29.000+0000",
"sparkCoresDurationSeconds": 0,
"inputDataBytes": 0,
"outputDataBytes": 0,
"durationSeconds": 0,
"efficiencyPercent": 0
}
}
}
],
"trends": {"inputDataBytes": {"last": 49,
"deltaLast10": 0.2
},
"outputDataBytes": {"last": 49,
"deltaLast10": 0.2
},
"costCents": {"last": 49,
"deltaLast10": 0.2
},
"sparkCoresDurationSeconds": {"last": 3600,
"deltaLast10": 0.2
},
"durationSeconds": {"last": 3600,
"deltaLast10": 0.2
},
"efficiencyPercent": {"last": 0.8,
"deltaLast10": 0.2
}
}
}
],
"count": 1,
"kind": "string"
}
}

List Jobs in Cluster

List the Ocean Spark jobs in a specific cluster.

Authorizations:

path Parameters

clusterId

required

string (oceanSparkClusterId)

Example: osc-20fac3f1

A unique identifier for the Ocean Spark cluster

query Parameters

accountId

string

Example: accountId=act-123456789

The ID of the account associated with your token. If omitted the oldest account in the organization will be used.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"internalId": "fa61bb92-4bb7-49aa-87d3-7823bd263d1e",
"id": "daily-reporting",
"displayName": "Daily Reporting",
"controllerClusterId": "my-ocean-cluster",
"clusterId": "osc-20fac3f1",
"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-10-10T10:50:29.000+0000",
"lastApp": {"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-11-01T10:50:29.000+0000",
"internalId": "fa61bb92-4bb7-49aa-87d3-7823bd263d1e",
"id": "daily-reporting-2021-08-18",
"displayName": "Daily Reporting 2021-08-18",
"userId": 59438,
"clusterId": "osc-20fac3f1",
"controllerClusterId": "my-ocean-cluster",
"appState": "RUNNING",
"submissionSource": "public-api",
"job": {"id": "daily-reporting",
"displayName": "Daily Reporting"
},
"config": {"arguments": ["string"
],
"deps": {"files": ["string"
],
"jars": ["string"
],
"pyFiles": ["string"
]
},
"driver": {"affinity": {"nodeAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"preference": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": {"nodeSelectorTerms": [{"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
}
]
}
},
"podAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
},
"podAntiAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
}
},
"annotations": {"property1": "string",
"property2": "string"
},
"configMaps": [{"name": "string",
"path": "string"
}
],
"coreLimit": "string",
"coreRequest": "string",
"cores": 0,
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envSecretKeyRefs": {"property1": {"key": "string",
"name": "string"
},
"property2": {"key": "string",
"name": "string"
}
},
"envVars": {"property1": "string",
"property2": "string"
},
"hostAliases": [{"hostnames": ["string"
],
"ip": "string"
}
],
"image": "string",
"instanceSelector": "string",
"instanceAllowList": "string",
"javaOptions": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"sidecars": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"initContainers": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"labels": {"property1": "string",
"property2": "string"
},
"memory": "string",
"memoryOverhead": "string",
"podName": "string",
"podSecurityContext": {"fsGroup": 0,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"supplementalGroups": [0
],
"sysctls": [{"name": "string",
"value": "string"
}
],
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"secrets": [{"name": "string",
"path": "string",
"secretType": "GCPServiceAccount"
}
],
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"spot": true,
"tolerations": [{"effect": "string",
"key": "string",
"operator": "string",
"tolerationSeconds": 0,
"value": "string"
}
],
"vngIds": ["string"
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
]
},
"executor": {"affinity": {"nodeAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"preference": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": {"nodeSelectorTerms": [{"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
}
]
}
},
"podAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
},
"podAntiAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
}
},
"annotations": {"property1": "string",
"property2": "string"
},
"configMaps": [{"name": "string",
"path": "string"
}
],
"coreLimit": "string",
"coreRequest": "string",
"cores": 0,
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envSecretKeyRefs": {"property1": {"key": "string",
"name": "string"
},
"property2": {"key": "string",
"name": "string"
}
},
"envVars": {"property1": "string",
"property2": "string"
},
"hostAliases": [{"hostnames": ["string"
],
"ip": "string"
}
],
"image": "string",
"instanceSelector": "string",
"instanceAllowList": "string",
"sidecars": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"initContainers": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"instances": 0,
"javaOptions": "string",
"labels": {"property1": "string",
"property2": "string"
},
"memory": "string",
"memoryOverhead": "string",
"podSecurityContext": {"fsGroup": 0,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"supplementalGroups": [0
],
"sysctls": [{"name": "string",
"value": "string"
}
],
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"secrets": [{"name": "string",
"path": "string",
"secretType": "GCPServiceAccount"
}
],
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"spot": true,
"tolerations": [{"effect": "string",
"key": "string",
"operator": "string",
"tolerationSeconds": 0,
"value": "string"
}
],
"vngIds": ["string"
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
]
},
"hadoopConf": {"property1": "string",
"property2": "string"
},
"hadoopConfigMap": "string",
"image": "string",
"imagePullPolicy": "string",
"imagePullSecrets": ["string"
],
"initContainerImage": "string",
"mainApplicationFile": "string",
"mainClass": "string",
"memoryOverheadFactor": "string",
"availabilityZone": "string",
"pythonVersion": "3",
"sparkConf": {"property1": "string",
"property2": "string"
},
"sparkConfigMap": "string",
"sparkVersion": "string",
"timeout": "DISABLED",
"timeToLiveSeconds": 0,
"type": "Java",
"volumes": [{"awsElasticBlockStore": {"fsType": "string",
"partition": 0,
"readOnly": true,
"volumeID": "string"
},
"azureDisk": {"cachingMode": "string",
"diskName": "string",
"diskURI": "string",
"fsType": "string",
"kind": "string",
"readOnly": true
},
"azureFile": {"readOnly": true,
"secretName": "string",
"shareName": "string"
},
"cephfs": {"monitors": ["string"
],
"path": "string",
"readOnly": true,
"secretFile": "string",
"secretRef": {"name": "string"
},
"user": "string"
},
"cinder": {"fsType": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"volumeID": "string"
},
"configMap": {"defaultMode": 0,
"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"csi": {"driver": "string",
"fsType": "string",
"nodePublishSecretRef": {"name": "string"
},
"readOnly": true,
"volumeAttributes": {"property1": "string",
"property2": "string"
}
},
"downwardAPI": {"defaultMode": 0,
"items": [{"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"mode": 0,
"path": "string",
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
}
}
]
},
"emptyDir": {"medium": "string",
"sizeLimit": "string"
},
"fc": {"fsType": "string",
"lun": 0,
"readOnly": true,
"targetWWNs": ["string"
],
"wwids": ["string"
]
},
"flexVolume": {"driver": "string",
"fsType": "string",
"options": {"property1": "string",
"property2": "string"
},
"readOnly": true,
"secretRef": {"name": "string"
}
},
"flocker": {"datasetName": "string",
"datasetUUID": "string"
},
"gcePersistentDisk": {"fsType": "string",
"partition": 0,
"pdName": "string",
"readOnly": true
},
"gitRepo": {"directory": "string",
"repository": "string",
"revision": "string"
},
"glusterfs": {"endpoints": "string",
"path": "string",
"readOnly": true
},
"hostPath": {"path": "string",
"type": "string"
},
"iscsi": {"chapAuthDiscovery": true,
"chapAuthSession": true,
"fsType": "string",
"initiatorName": "string",
"iqn": "string",
"iscsiInterface": "string",
"lun": 0,
"portals": ["string"
],
"readOnly": true,
"secretRef": {"name": "string"
},
"targetPortal": "string"
},
"name": "string",
"nfs": {"path": "string",
"readOnly": true,
"server": "string"
},
"persistentVolumeClaim": {"claimName": "string",
"readOnly": true
},
"photonPersistentDisk": {"fsType": "string",
"pdID": "string"
},
"portworxVolume": {"fsType": "string",
"readOnly": true,
"volumeID": "string"
},
"projected": {"defaultMode": 0,
"sources": [{"configMap": {"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"downwardAPI": {"items": [{"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"mode": 0,
"path": "string",
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
}
}
]
},
"secret": {"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"serviceAccountToken": {"audience": "string",
"expirationSeconds": 0,
"path": "string"
}
}
]
},
"quobyte": {"group": "string",
"readOnly": true,
"registry": "string",
"tenant": "string",
"user": "string",
"volume": "string"
},
"rbd": {"fsType": "string",
"image": "string",
"keyring": "string",
"monitors": ["string"
],
"pool": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"user": "string"
},
"scaleIO": {"fsType": "string",
"gateway": "string",
"protectionDomain": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"sslEnabled": true,
"storageMode": "string",
"storagePool": "string",
"system": "string",
"volumeName": "string"
},
"secret": {"defaultMode": 0,
"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"optional": true,
"secretName": "string"
},
"storageos": {"fsType": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"volumeName": "string",
"volumeNamespace": "string"
},
"vsphereVolume": {"fsType": "string",
"storagePolicyID": "string",
"storagePolicyName": "string",
"volumePath": "string"
}
}
]
},
"startedAt": "2021-11-18T17:09:37+00:00",
"endedAt": "2021-11-18T17:09:37+00:00",
"log": {"logsStreamUrl": "/ocean/spark/cluster/osc-20fac3f1/app/daily-reporting-2021-08-18/logs/live",
"kubeEventsStreamUrl": "/ocean/spark/cluster/osc-20fac3f1/app/daily-reporting-2021-08-18/kubeEvents/live"
},
"metrics": {"cost": {"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-10-10T10:50:29.000+0000",
"total": 0
},
"spark": {"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-10-10T10:50:29.000+0000",
"sparkCoresDurationSeconds": 0,
"inputDataBytes": 0,
"outputDataBytes": 0,
"durationSeconds": 0,
"efficiencyPercent": 0
}
}
},
"history": [{"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-11-01T10:50:29.000+0000",
"internalId": "fa61bb92-4bb7-49aa-87d3-7823bd263d1e",
"id": "daily-reporting-2021-08-18",
"displayName": "Daily Reporting 2021-08-18",
"userId": 59438,
"clusterId": "osc-20fac3f1",
"controllerClusterId": "my-ocean-cluster",
"appState": "RUNNING",
"submissionSource": "public-api",
"job": {"id": "daily-reporting",
"displayName": "Daily Reporting"
},
"config": {"arguments": ["string"
],
"deps": {"files": ["string"
],
"jars": ["string"
],
"pyFiles": ["string"
]
},
"driver": {"affinity": {"nodeAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"preference": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": {"nodeSelectorTerms": [{"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
}
]
}
},
"podAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
},
"podAntiAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
}
},
"annotations": {"property1": "string",
"property2": "string"
},
"configMaps": [{"name": "string",
"path": "string"
}
],
"coreLimit": "string",
"coreRequest": "string",
"cores": 0,
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envSecretKeyRefs": {"property1": {"key": "string",
"name": "string"
},
"property2": {"key": "string",
"name": "string"
}
},
"envVars": {"property1": "string",
"property2": "string"
},
"hostAliases": [{"hostnames": ["string"
],
"ip": "string"
}
],
"image": "string",
"instanceSelector": "string",
"instanceAllowList": "string",
"javaOptions": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"sidecars": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"initContainers": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"labels": {"property1": "string",
"property2": "string"
},
"memory": "string",
"memoryOverhead": "string",
"podName": "string",
"podSecurityContext": {"fsGroup": 0,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"supplementalGroups": [0
],
"sysctls": [{"name": "string",
"value": "string"
}
],
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"secrets": [{"name": "string",
"path": "string",
"secretType": "GCPServiceAccount"
}
],
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"spot": true,
"tolerations": [{"effect": "string",
"key": "string",
"operator": "string",
"tolerationSeconds": 0,
"value": "string"
}
],
"vngIds": ["string"
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
]
},
"executor": {"affinity": {"nodeAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"preference": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": {"nodeSelectorTerms": [{"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
}
]
}
},
"podAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
},
"podAntiAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
}
},
"annotations": {"property1": "string",
"property2": "string"
},
"configMaps": [{"name": "string",
"path": "string"
}
],
"coreLimit": "string",
"coreRequest": "string",
"cores": 0,
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envSecretKeyRefs": {"property1": {"key": "string",
"name": "string"
},
"property2": {"key": "string",
"name": "string"
}
},
"envVars": {"property1": "string",
"property2": "string"
},
"hostAliases": [{"hostnames": ["string"
],
"ip": "string"
}
],
"image": "string",
"instanceSelector": "string",
"instanceAllowList": "string",
"sidecars": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"initContainers": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"instances": 0,
"javaOptions": "string",
"labels": {"property1": "string",
"property2": "string"
},
"memory": "string",
"memoryOverhead": "string",
"podSecurityContext": {"fsGroup": 0,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"supplementalGroups": [0
],
"sysctls": [{"name": "string",
"value": "string"
}
],
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"secrets": [{"name": "string",
"path": "string",
"secretType": "GCPServiceAccount"
}
],
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"spot": true,
"tolerations": [{"effect": "string",
"key": "string",
"operator": "string",
"tolerationSeconds": 0,
"value": "string"
}
],
"vngIds": ["string"
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
]
},
"hadoopConf": {"property1": "string",
"property2": "string"
},
"hadoopConfigMap": "string",
"image": "string",
"imagePullPolicy": "string",
"imagePullSecrets": ["string"
],
"initContainerImage": "string",
"mainApplicationFile": "string",
"mainClass": "string",
"memoryOverheadFactor": "string",
"availabilityZone": "string",
"pythonVersion": "3",
"sparkConf": {"property1": "string",
"property2": "string"
},
"sparkConfigMap": "string",
"sparkVersion": "string",
"timeout": "DISABLED",
"timeToLiveSeconds": 0,
"type": "Java",
"volumes": [{"awsElasticBlockStore": {"fsType": "string",
"partition": 0,
"readOnly": true,
"volumeID": "string"
},
"azureDisk": {"cachingMode": "string",
"diskName": "string",
"diskURI": "string",
"fsType": "string",
"kind": "string",
"readOnly": true
},
"azureFile": {"readOnly": true,
"secretName": "string",
"shareName": "string"
},
"cephfs": {"monitors": ["string"
],
"path": "string",
"readOnly": true,
"secretFile": "string",
"secretRef": {"name": "string"
},
"user": "string"
},
"cinder": {"fsType": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"volumeID": "string"
},
"configMap": {"defaultMode": 0,
"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"csi": {"driver": "string",
"fsType": "string",
"nodePublishSecretRef": {"name": "string"
},
"readOnly": true,
"volumeAttributes": {"property1": "string",
"property2": "string"
}
},
"downwardAPI": {"defaultMode": 0,
"items": [{"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"mode": 0,
"path": "string",
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
}
}
]
},
"emptyDir": {"medium": "string",
"sizeLimit": "string"
},
"fc": {"fsType": "string",
"lun": 0,
"readOnly": true,
"targetWWNs": ["string"
],
"wwids": ["string"
]
},
"flexVolume": {"driver": "string",
"fsType": "string",
"options": {"property1": "string",
"property2": "string"
},
"readOnly": true,
"secretRef": {"name": "string"
}
},
"flocker": {"datasetName": "string",
"datasetUUID": "string"
},
"gcePersistentDisk": {"fsType": "string",
"partition": 0,
"pdName": "string",
"readOnly": true
},
"gitRepo": {"directory": "string",
"repository": "string",
"revision": "string"
},
"glusterfs": {"endpoints": "string",
"path": "string",
"readOnly": true
},
"hostPath": {"path": "string",
"type": "string"
},
"iscsi": {"chapAuthDiscovery": true,
"chapAuthSession": true,
"fsType": "string",
"initiatorName": "string",
"iqn": "string",
"iscsiInterface": "string",
"lun": 0,
"portals": ["string"
],
"readOnly": true,
"secretRef": {"name": "string"
},
"targetPortal": "string"
},
"name": "string",
"nfs": {"path": "string",
"readOnly": true,
"server": "string"
},
"persistentVolumeClaim": {"claimName": "string",
"readOnly": true
},
"photonPersistentDisk": {"fsType": "string",
"pdID": "string"
},
"portworxVolume": {"fsType": "string",
"readOnly": true,
"volumeID": "string"
},
"projected": {"defaultMode": 0,
"sources": [{"configMap": {"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"downwardAPI": {"items": [{"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"mode": 0,
"path": "string",
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
}
}
]
},
"secret": {"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"serviceAccountToken": {"audience": "string",
"expirationSeconds": 0,
"path": "string"
}
}
]
},
"quobyte": {"group": "string",
"readOnly": true,
"registry": "string",
"tenant": "string",
"user": "string",
"volume": "string"
},
"rbd": {"fsType": "string",
"image": "string",
"keyring": "string",
"monitors": ["string"
],
"pool": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"user": "string"
},
"scaleIO": {"fsType": "string",
"gateway": "string",
"protectionDomain": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"sslEnabled": true,
"storageMode": "string",
"storagePool": "string",
"system": "string",
"volumeName": "string"
},
"secret": {"defaultMode": 0,
"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"optional": true,
"secretName": "string"
},
"storageos": {"fsType": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"volumeName": "string",
"volumeNamespace": "string"
},
"vsphereVolume": {"fsType": "string",
"storagePolicyID": "string",
"storagePolicyName": "string",
"volumePath": "string"
}
}
]
},
"startedAt": "2021-11-18T17:09:37+00:00",
"endedAt": "2021-11-18T17:09:37+00:00",
"log": {"logsStreamUrl": "/ocean/spark/cluster/osc-20fac3f1/app/daily-reporting-2021-08-18/logs/live",
"kubeEventsStreamUrl": "/ocean/spark/cluster/osc-20fac3f1/app/daily-reporting-2021-08-18/kubeEvents/live"
},
"metrics": {"cost": {"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-10-10T10:50:29.000+0000",
"total": 0
},
"spark": {"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-10-10T10:50:29.000+0000",
"sparkCoresDurationSeconds": 0,
"inputDataBytes": 0,
"outputDataBytes": 0,
"durationSeconds": 0,
"efficiencyPercent": 0
}
}
}
],
"trends": {"inputDataBytes": {"last": 49,
"deltaLast10": 0.2
},
"outputDataBytes": {"last": 49,
"deltaLast10": 0.2
},
"costCents": {"last": 49,
"deltaLast10": 0.2
},
"sparkCoresDurationSeconds": {"last": 3600,
"deltaLast10": 0.2
},
"durationSeconds": {"last": 3600,
"deltaLast10": 0.2
},
"efficiencyPercent": {"last": 0.8,
"deltaLast10": 0.2
}
}
}
],
"count": 1,
"kind": "string"
}
}

Get Job

Describe an Ocean Spark job in an Ocean Spark cluster.

Authorizations:

path Parameters

clusterId required	string (oceanSparkClusterId) Example: osc-20fac3f1 A unique identifier for the Ocean Spark cluster
jobId required	string (oceanSparkJobId) ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a... Example: daily-reporting A unique identifier for an Ocean Spark job.

query Parameters

accountId

string

Example: accountId=act-123456789

The ID of the account associated with your token. If omitted the oldest account in the organization will be used.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"internalId": "fa61bb92-4bb7-49aa-87d3-7823bd263d1e",
"id": "daily-reporting",
"displayName": "Daily Reporting",
"controllerClusterId": "my-ocean-cluster",
"clusterId": "osc-20fac3f1",
"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-10-10T10:50:29.000+0000",
"lastApp": {"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-11-01T10:50:29.000+0000",
"internalId": "fa61bb92-4bb7-49aa-87d3-7823bd263d1e",
"id": "daily-reporting-2021-08-18",
"displayName": "Daily Reporting 2021-08-18",
"userId": 59438,
"clusterId": "osc-20fac3f1",
"controllerClusterId": "my-ocean-cluster",
"appState": "RUNNING",
"submissionSource": "public-api",
"job": {"id": "daily-reporting",
"displayName": "Daily Reporting"
},
"config": {"arguments": ["string"
],
"deps": {"files": ["string"
],
"jars": ["string"
],
"pyFiles": ["string"
]
},
"driver": {"affinity": {"nodeAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"preference": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": {"nodeSelectorTerms": [{"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
}
]
}
},
"podAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
},
"podAntiAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
}
},
"annotations": {"property1": "string",
"property2": "string"
},
"configMaps": [{"name": "string",
"path": "string"
}
],
"coreLimit": "string",
"coreRequest": "string",
"cores": 0,
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envSecretKeyRefs": {"property1": {"key": "string",
"name": "string"
},
"property2": {"key": "string",
"name": "string"
}
},
"envVars": {"property1": "string",
"property2": "string"
},
"hostAliases": [{"hostnames": ["string"
],
"ip": "string"
}
],
"image": "string",
"instanceSelector": "string",
"instanceAllowList": "string",
"javaOptions": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"sidecars": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"initContainers": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"labels": {"property1": "string",
"property2": "string"
},
"memory": "string",
"memoryOverhead": "string",
"podName": "string",
"podSecurityContext": {"fsGroup": 0,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"supplementalGroups": [0
],
"sysctls": [{"name": "string",
"value": "string"
}
],
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"secrets": [{"name": "string",
"path": "string",
"secretType": "GCPServiceAccount"
}
],
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"spot": true,
"tolerations": [{"effect": "string",
"key": "string",
"operator": "string",
"tolerationSeconds": 0,
"value": "string"
}
],
"vngIds": ["string"
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
]
},
"executor": {"affinity": {"nodeAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"preference": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": {"nodeSelectorTerms": [{"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
}
]
}
},
"podAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
},
"podAntiAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
}
},
"annotations": {"property1": "string",
"property2": "string"
},
"configMaps": [{"name": "string",
"path": "string"
}
],
"coreLimit": "string",
"coreRequest": "string",
"cores": 0,
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envSecretKeyRefs": {"property1": {"key": "string",
"name": "string"
},
"property2": {"key": "string",
"name": "string"
}
},
"envVars": {"property1": "string",
"property2": "string"
},
"hostAliases": [{"hostnames": ["string"
],
"ip": "string"
}
],
"image": "string",
"instanceSelector": "string",
"instanceAllowList": "string",
"sidecars": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"initContainers": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"instances": 0,
"javaOptions": "string",
"labels": {"property1": "string",
"property2": "string"
},
"memory": "string",
"memoryOverhead": "string",
"podSecurityContext": {"fsGroup": 0,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"supplementalGroups": [0
],
"sysctls": [{"name": "string",
"value": "string"
}
],
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"secrets": [{"name": "string",
"path": "string",
"secretType": "GCPServiceAccount"
}
],
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"spot": true,
"tolerations": [{"effect": "string",
"key": "string",
"operator": "string",
"tolerationSeconds": 0,
"value": "string"
}
],
"vngIds": ["string"
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
]
},
"hadoopConf": {"property1": "string",
"property2": "string"
},
"hadoopConfigMap": "string",
"image": "string",
"imagePullPolicy": "string",
"imagePullSecrets": ["string"
],
"initContainerImage": "string",
"mainApplicationFile": "string",
"mainClass": "string",
"memoryOverheadFactor": "string",
"availabilityZone": "string",
"pythonVersion": "3",
"sparkConf": {"property1": "string",
"property2": "string"
},
"sparkConfigMap": "string",
"sparkVersion": "string",
"timeout": "DISABLED",
"timeToLiveSeconds": 0,
"type": "Java",
"volumes": [{"awsElasticBlockStore": {"fsType": "string",
"partition": 0,
"readOnly": true,
"volumeID": "string"
},
"azureDisk": {"cachingMode": "string",
"diskName": "string",
"diskURI": "string",
"fsType": "string",
"kind": "string",
"readOnly": true
},
"azureFile": {"readOnly": true,
"secretName": "string",
"shareName": "string"
},
"cephfs": {"monitors": ["string"
],
"path": "string",
"readOnly": true,
"secretFile": "string",
"secretRef": {"name": "string"
},
"user": "string"
},
"cinder": {"fsType": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"volumeID": "string"
},
"configMap": {"defaultMode": 0,
"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"csi": {"driver": "string",
"fsType": "string",
"nodePublishSecretRef": {"name": "string"
},
"readOnly": true,
"volumeAttributes": {"property1": "string",
"property2": "string"
}
},
"downwardAPI": {"defaultMode": 0,
"items": [{"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"mode": 0,
"path": "string",
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
}
}
]
},
"emptyDir": {"medium": "string",
"sizeLimit": "string"
},
"fc": {"fsType": "string",
"lun": 0,
"readOnly": true,
"targetWWNs": ["string"
],
"wwids": ["string"
]
},
"flexVolume": {"driver": "string",
"fsType": "string",
"options": {"property1": "string",
"property2": "string"
},
"readOnly": true,
"secretRef": {"name": "string"
}
},
"flocker": {"datasetName": "string",
"datasetUUID": "string"
},
"gcePersistentDisk": {"fsType": "string",
"partition": 0,
"pdName": "string",
"readOnly": true
},
"gitRepo": {"directory": "string",
"repository": "string",
"revision": "string"
},
"glusterfs": {"endpoints": "string",
"path": "string",
"readOnly": true
},
"hostPath": {"path": "string",
"type": "string"
},
"iscsi": {"chapAuthDiscovery": true,
"chapAuthSession": true,
"fsType": "string",
"initiatorName": "string",
"iqn": "string",
"iscsiInterface": "string",
"lun": 0,
"portals": ["string"
],
"readOnly": true,
"secretRef": {"name": "string"
},
"targetPortal": "string"
},
"name": "string",
"nfs": {"path": "string",
"readOnly": true,
"server": "string"
},
"persistentVolumeClaim": {"claimName": "string",
"readOnly": true
},
"photonPersistentDisk": {"fsType": "string",
"pdID": "string"
},
"portworxVolume": {"fsType": "string",
"readOnly": true,
"volumeID": "string"
},
"projected": {"defaultMode": 0,
"sources": [{"configMap": {"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"downwardAPI": {"items": [{"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"mode": 0,
"path": "string",
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
}
}
]
},
"secret": {"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"serviceAccountToken": {"audience": "string",
"expirationSeconds": 0,
"path": "string"
}
}
]
},
"quobyte": {"group": "string",
"readOnly": true,
"registry": "string",
"tenant": "string",
"user": "string",
"volume": "string"
},
"rbd": {"fsType": "string",
"image": "string",
"keyring": "string",
"monitors": ["string"
],
"pool": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"user": "string"
},
"scaleIO": {"fsType": "string",
"gateway": "string",
"protectionDomain": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"sslEnabled": true,
"storageMode": "string",
"storagePool": "string",
"system": "string",
"volumeName": "string"
},
"secret": {"defaultMode": 0,
"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"optional": true,
"secretName": "string"
},
"storageos": {"fsType": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"volumeName": "string",
"volumeNamespace": "string"
},
"vsphereVolume": {"fsType": "string",
"storagePolicyID": "string",
"storagePolicyName": "string",
"volumePath": "string"
}
}
]
},
"startedAt": "2021-11-18T17:09:37+00:00",
"endedAt": "2021-11-18T17:09:37+00:00",
"log": {"logsStreamUrl": "/ocean/spark/cluster/osc-20fac3f1/app/daily-reporting-2021-08-18/logs/live",
"kubeEventsStreamUrl": "/ocean/spark/cluster/osc-20fac3f1/app/daily-reporting-2021-08-18/kubeEvents/live"
},
"metrics": {"cost": {"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-10-10T10:50:29.000+0000",
"total": 0
},
"spark": {"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-10-10T10:50:29.000+0000",
"sparkCoresDurationSeconds": 0,
"inputDataBytes": 0,
"outputDataBytes": 0,
"durationSeconds": 0,
"efficiencyPercent": 0
}
}
},
"history": [{"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-11-01T10:50:29.000+0000",
"internalId": "fa61bb92-4bb7-49aa-87d3-7823bd263d1e",
"id": "daily-reporting-2021-08-18",
"displayName": "Daily Reporting 2021-08-18",
"userId": 59438,
"clusterId": "osc-20fac3f1",
"controllerClusterId": "my-ocean-cluster",
"appState": "RUNNING",
"submissionSource": "public-api",
"job": {"id": "daily-reporting",
"displayName": "Daily Reporting"
},
"config": {"arguments": ["string"
],
"deps": {"files": ["string"
],
"jars": ["string"
],
"pyFiles": ["string"
]
},
"driver": {"affinity": {"nodeAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"preference": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": {"nodeSelectorTerms": [{"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
}
]
}
},
"podAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
},
"podAntiAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
}
},
"annotations": {"property1": "string",
"property2": "string"
},
"configMaps": [{"name": "string",
"path": "string"
}
],
"coreLimit": "string",
"coreRequest": "string",
"cores": 0,
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envSecretKeyRefs": {"property1": {"key": "string",
"name": "string"
},
"property2": {"key": "string",
"name": "string"
}
},
"envVars": {"property1": "string",
"property2": "string"
},
"hostAliases": [{"hostnames": ["string"
],
"ip": "string"
}
],
"image": "string",
"instanceSelector": "string",
"instanceAllowList": "string",
"javaOptions": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"sidecars": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"initContainers": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"labels": {"property1": "string",
"property2": "string"
},
"memory": "string",
"memoryOverhead": "string",
"podName": "string",
"podSecurityContext": {"fsGroup": 0,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"supplementalGroups": [0
],
"sysctls": [{"name": "string",
"value": "string"
}
],
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"secrets": [{"name": "string",
"path": "string",
"secretType": "GCPServiceAccount"
}
],
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"spot": true,
"tolerations": [{"effect": "string",
"key": "string",
"operator": "string",
"tolerationSeconds": 0,
"value": "string"
}
],
"vngIds": ["string"
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
]
},
"executor": {"affinity": {"nodeAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"preference": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": {"nodeSelectorTerms": [{"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchFields": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
]
}
]
}
},
"podAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
},
"podAntiAffinity": {"preferredDuringSchedulingIgnoredDuringExecution": [{"podAffinityTerm": {"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [{"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
},
"namespaces": ["string"
],
"topologyKey": "string"
}
]
}
},
"annotations": {"property1": "string",
"property2": "string"
},
"configMaps": [{"name": "string",
"path": "string"
}
],
"coreLimit": "string",
"coreRequest": "string",
"cores": 0,
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envSecretKeyRefs": {"property1": {"key": "string",
"name": "string"
},
"property2": {"key": "string",
"name": "string"
}
},
"envVars": {"property1": "string",
"property2": "string"
},
"hostAliases": [{"hostnames": ["string"
],
"ip": "string"
}
],
"image": "string",
"instanceSelector": "string",
"instanceAllowList": "string",
"sidecars": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"initContainers": [{"args": ["string"
],
"command": ["string"
],
"env": [{"name": "string",
"value": "string",
"valueFrom": {"configMapKeyRef": {"key": "string",
"name": "string",
"optional": true
},
"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
},
"secretKeyRef": {"key": "string",
"name": "string",
"optional": true
}
}
}
],
"envFrom": [{"configMapRef": {"name": "string",
"optional": true
},
"prefix": "string",
"secretRef": {"name": "string",
"optional": true
}
}
],
"image": "string",
"imagePullPolicy": "string",
"lifecycle": {"postStart": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
},
"preStop": {"exec": {"command": ["string"
]
},
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"tcpSocket": {"host": "string",
"port": "string"
}
}
},
"livenessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"name": "string",
"ports": [{"containerPort": 0,
"hostIP": "string",
"hostPort": 0,
"name": "string",
"protocol": "string"
}
],
"readinessProbe": {"exec": {"command": ["string"
]
},
"failureThreshold": 0,
"httpGet": {"host": "string",
"httpHeaders": [{"name": "string",
"value": "string"
}
],
"path": "string",
"port": "string",
"scheme": "string"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {"host": "string",
"port": "string"
},
"timeoutSeconds": 0
},
"resources": {"limits": {"property1": "string",
"property2": "string"
},
"requests": {"property1": "string",
"property2": "string"
}
},
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"stdin": true,
"stdinOnce": true,
"terminationMessagePath": "string",
"terminationMessagePolicy": "string",
"tty": true,
"volumeDevices": [{"devicePath": "string",
"name": "string"
}
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
],
"workingDir": "string"
}
],
"instances": 0,
"javaOptions": "string",
"labels": {"property1": "string",
"property2": "string"
},
"memory": "string",
"memoryOverhead": "string",
"podSecurityContext": {"fsGroup": 0,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"supplementalGroups": [0
],
"sysctls": [{"name": "string",
"value": "string"
}
],
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"secrets": [{"name": "string",
"path": "string",
"secretType": "GCPServiceAccount"
}
],
"securityContext": {"allowPrivilegeEscalation": true,
"capabilities": {"add": ["string"
],
"drop": ["string"
]
},
"privileged": true,
"procMount": "string",
"readOnlyRootFilesystem": true,
"runAsGroup": 0,
"runAsNonRoot": true,
"runAsUser": 0,
"seLinuxOptions": {"level": "string",
"role": "string",
"type": "string",
"user": "string"
},
"windowsOptions": {"gmsaCredentialSpec": "string",
"gmsaCredentialSpecName": "string"
}
},
"spot": true,
"tolerations": [{"effect": "string",
"key": "string",
"operator": "string",
"tolerationSeconds": 0,
"value": "string"
}
],
"vngIds": ["string"
],
"volumeMounts": [{"mountPath": "string",
"mountPropagation": "string",
"name": "string",
"readOnly": true,
"subPath": "string",
"subPathExpr": "string"
}
]
},
"hadoopConf": {"property1": "string",
"property2": "string"
},
"hadoopConfigMap": "string",
"image": "string",
"imagePullPolicy": "string",
"imagePullSecrets": ["string"
],
"initContainerImage": "string",
"mainApplicationFile": "string",
"mainClass": "string",
"memoryOverheadFactor": "string",
"availabilityZone": "string",
"pythonVersion": "3",
"sparkConf": {"property1": "string",
"property2": "string"
},
"sparkConfigMap": "string",
"sparkVersion": "string",
"timeout": "DISABLED",
"timeToLiveSeconds": 0,
"type": "Java",
"volumes": [{"awsElasticBlockStore": {"fsType": "string",
"partition": 0,
"readOnly": true,
"volumeID": "string"
},
"azureDisk": {"cachingMode": "string",
"diskName": "string",
"diskURI": "string",
"fsType": "string",
"kind": "string",
"readOnly": true
},
"azureFile": {"readOnly": true,
"secretName": "string",
"shareName": "string"
},
"cephfs": {"monitors": ["string"
],
"path": "string",
"readOnly": true,
"secretFile": "string",
"secretRef": {"name": "string"
},
"user": "string"
},
"cinder": {"fsType": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"volumeID": "string"
},
"configMap": {"defaultMode": 0,
"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"csi": {"driver": "string",
"fsType": "string",
"nodePublishSecretRef": {"name": "string"
},
"readOnly": true,
"volumeAttributes": {"property1": "string",
"property2": "string"
}
},
"downwardAPI": {"defaultMode": 0,
"items": [{"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"mode": 0,
"path": "string",
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
}
}
]
},
"emptyDir": {"medium": "string",
"sizeLimit": "string"
},
"fc": {"fsType": "string",
"lun": 0,
"readOnly": true,
"targetWWNs": ["string"
],
"wwids": ["string"
]
},
"flexVolume": {"driver": "string",
"fsType": "string",
"options": {"property1": "string",
"property2": "string"
},
"readOnly": true,
"secretRef": {"name": "string"
}
},
"flocker": {"datasetName": "string",
"datasetUUID": "string"
},
"gcePersistentDisk": {"fsType": "string",
"partition": 0,
"pdName": "string",
"readOnly": true
},
"gitRepo": {"directory": "string",
"repository": "string",
"revision": "string"
},
"glusterfs": {"endpoints": "string",
"path": "string",
"readOnly": true
},
"hostPath": {"path": "string",
"type": "string"
},
"iscsi": {"chapAuthDiscovery": true,
"chapAuthSession": true,
"fsType": "string",
"initiatorName": "string",
"iqn": "string",
"iscsiInterface": "string",
"lun": 0,
"portals": ["string"
],
"readOnly": true,
"secretRef": {"name": "string"
},
"targetPortal": "string"
},
"name": "string",
"nfs": {"path": "string",
"readOnly": true,
"server": "string"
},
"persistentVolumeClaim": {"claimName": "string",
"readOnly": true
},
"photonPersistentDisk": {"fsType": "string",
"pdID": "string"
},
"portworxVolume": {"fsType": "string",
"readOnly": true,
"volumeID": "string"
},
"projected": {"defaultMode": 0,
"sources": [{"configMap": {"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"downwardAPI": {"items": [{"fieldRef": {"apiVersion": "string",
"fieldPath": "string"
},
"mode": 0,
"path": "string",
"resourceFieldRef": {"containerName": "string",
"divisor": "string",
"resource": "string"
}
}
]
},
"secret": {"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"name": "string",
"optional": true
},
"serviceAccountToken": {"audience": "string",
"expirationSeconds": 0,
"path": "string"
}
}
]
},
"quobyte": {"group": "string",
"readOnly": true,
"registry": "string",
"tenant": "string",
"user": "string",
"volume": "string"
},
"rbd": {"fsType": "string",
"image": "string",
"keyring": "string",
"monitors": ["string"
],
"pool": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"user": "string"
},
"scaleIO": {"fsType": "string",
"gateway": "string",
"protectionDomain": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"sslEnabled": true,
"storageMode": "string",
"storagePool": "string",
"system": "string",
"volumeName": "string"
},
"secret": {"defaultMode": 0,
"items": [{"key": "string",
"mode": 0,
"path": "string"
}
],
"optional": true,
"secretName": "string"
},
"storageos": {"fsType": "string",
"readOnly": true,
"secretRef": {"name": "string"
},
"volumeName": "string",
"volumeNamespace": "string"
},
"vsphereVolume": {"fsType": "string",
"storagePolicyID": "string",
"storagePolicyName": "string",
"volumePath": "string"
}
}
]
},
"startedAt": "2021-11-18T17:09:37+00:00",
"endedAt": "2021-11-18T17:09:37+00:00",
"log": {"logsStreamUrl": "/ocean/spark/cluster/osc-20fac3f1/app/daily-reporting-2021-08-18/logs/live",
"kubeEventsStreamUrl": "/ocean/spark/cluster/osc-20fac3f1/app/daily-reporting-2021-08-18/kubeEvents/live"
},
"metrics": {"cost": {"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-10-10T10:50:29.000+0000",
"total": 0
},
"spark": {"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-10-10T10:50:29.000+0000",
"sparkCoresDurationSeconds": 0,
"inputDataBytes": 0,
"outputDataBytes": 0,
"durationSeconds": 0,
"efficiencyPercent": 0
}
}
}
],
"trends": {"inputDataBytes": {"last": 49,
"deltaLast10": 0.2
},
"outputDataBytes": {"last": 49,
"deltaLast10": 0.2
},
"costCents": {"last": 49,
"deltaLast10": 0.2
},
"sparkCoresDurationSeconds": {"last": 3600,
"deltaLast10": 0.2
},
"durationSeconds": {"last": 3600,
"deltaLast10": 0.2
},
"efficiencyPercent": {"last": 0.8,
"deltaLast10": 0.2
}
}
}
],
"count": 1,
"kind": "string"
}
}

Elastigroup AWS

Elastigroup for Amazon Web Services (AWS)

Create Elastigroup

Create a new AWS Elastigroup.

There are several third Party Integrations available, which can be activated based on your configuration, such as:

Rancher Elastigroup
Route53 Elastigroup
DockerSwarm Elastigroup
ECS Elastigroup
Beanstalk Elastigroup

You can create a beanstalk elastigroup with the following steps:
- Get the beanstalk configuration to JSON format
- Modify required parameters and post the JSON as a body to create a new elastigroup

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

required

object

Elastigroup Configuration

required	object (Elastigroup Capacity) Capacity Configuration
required	object (Elastigroup Compute)
description	string Describe your AWS Elastigroup
name required	string AWS Elastigroup Name
region required	string The AWS region your group will be created in. This parameter is required if you specify subnets (through compute.subnetIds). This parameter is optional if you specify Availability Zones (through compute.availabilityZones).
	object (Elastigroup Scaling)
	object (Elastigroup Scheduling) Schedule tasks to execute, using CRON expressions.
required	object (Elastigroup Strategy) Strategy
	object (Elastigroup Third Party Integrations) All definitions for using third-party Integrations

Responses

Request samples

Payload

Content type

application/json

{"group": {"name": "my-Elastigroup",
"description": "This Elastigroup is used for Development",
"region": "use-east-1",
"capacity": {"target": 1,
"minimum": 0,
"maximum": 10,
"unit": "instance"
},
"strategy": {"risk": 100,
"onDemandCount": 0,
"availabilityVsCost": "costOriented",
"fallbackToOd": true,
"utilizeReservedInstances": false,
"utilizeCommitments": false,
"drainingTimeout": 120,
"signals": [{"name": "INSTANCE_READY",
"timeout": 120
}
],
"persistence": [{"shouldPersistPrivateIp": true,
"shouldPersistRootDevice": true,
"shouldPersistBlockDevices": true,
"blockDevicesMode": "reattach"
}
],
"revertToSpot": {"performAt": "timeWindow",
"timeWindows": ["Mon:03:00-Wed:02:30"
]
},
"scalingStrategy": {"terminationPolicy": "default"
}
},
"compute": {"product": "Linux/UNIX",
"elasticIps": ["eipalloc-9d4e16f8"
],
"privateIps": ["172.1.1.0"
],
"instanceTypes": {"ondemand": "m3.medium",
"spot": [["c3.large",
"c4.large",
"m3.large",
"r3.large"
]
],
"preferredSpot": [["c4.large"
]
],
"weights": [{"instanceType": "c4.large",
"weightedCapacity": 8
}
]
},
"subnetIds": [["subnet-4c1d1538",
"subnet-2791bb61",
"subnet-703a6f58",
"subnet-c62846fc"
]
],
"availabilityZones": [{"name": "us-west-2a",
"subnetIds": [["subnet-4333093a"
]
],
"placementGroupName": "string"
}
],
"preferredAvailabilityZones": [["us-east-1a",
"us-east-1b"
]
],
"launchSpecification": {"creditSpecification": {"cpuCredits": "unlimited"
},
"loadBalancersConfig": {"loadBalancers": [{"name": "MyTargetGroup",
"arn": "arn:aws:elasticloadbalancing:us-west-2:922761411234:targetgroup/MyTargetGroup/1fe63217f8ff1234",
"type": "TARGET_GROUP",
"balancerId": "lb-123456789",
"targetSetId": "ts-123456789",
"azAwareness": false,
"autoWeight": true
}
]
},
"itf": {"fixedTargetGroups": false,
"weightStrategy": "custom",
"migrationHealthinessThreshold": 80,
"loadBalancers": [{"loadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188",
"listenerRules": [{"ruleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/0123456789012345/1234567890123456/234567890123456",
"staticTargetGroups": [{"arn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/blue-targets/73e2d6bc24d8a068",
"percentage": 0.5
}
]
}
],
"defaultStaticTargetGroups": [{"arn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/blue-targets/73e2d6bc24d8a067",
"percentage": 0.4
}
]
}
],
"targetGroupConfig": {"vpcId": "vpc-0410a20ec1702a537",
"healthCheckPath": "/index.html",
"healthCheckProtocol": "HTTP",
"healthCheckPort": "traffic-port",
"healthCheckIntervalSeconds": 40,
"healthCheckTimeoutSeconds": 20,
"healthyThresholdCount": 3,
"unhealthyThresholdCount": 4,
"port": 80,
"protocol": "HTTP",
"protocolVersion": "HTTP1",
"tags": [{"creator": "John Doe"
}
],
"matcher": {"httpCode": "200"
}
}
},
"healthCheckType": "EC2",
"healthCheckGracePeriod": 600,
"healthCheckUnhealthyDurationBeforeReplacement": 60,
"securityGroupIds": [["sg-0dfc2c8760df6fec7"
]
],
"monitoring": false,
"ebsOptimized": false,
"imageId": "ami-01e24be29428c15b2",
"images": [{"id": "ami-123456789"
}
],
"keyPair": "labs-oregon",
"blockDeviceMappings": [{"deviceName": "/dev/xvdcz",
"ebs": {"iops": 0,
"throughput": 125,
"volumeType": "gp2",
"deleteOnTermination": true,
"volumeSize": 12,
"dynamicVolumeSize": {"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
}
}
}
],
"networkInterfaces": [{"description": "string",
"deviceIndex": 0,
"secondaryPrivateIpAddressCount": 0,
"associatePublicIpAddress": true,
"deleteOnTermination": true,
"networkInterfaceId": "string",
"privateIpAddresses": [{"privateIpAddress": "string",
"primary": true
}
],
"subnetId": "string",
"associateIpv6Address": true
}
],
"iamRole": {"name": "my-iamRole"
},
"userData": "dXNlcmJhc2g2NGVuY29kZWQ=",
"shutdownScript": "dXNlcmJhc2g2NGVuY29kZWQ=",
"tags": [{"tagKey": "Creator",
"tagValue": "John Doe"
}
],
"resourceTagSpecification": {"volumes": {"shouldTag": false
},
"snapshots": {"shouldTag": true
},
"enis": {"shouldTag": false
},
"amis": {"shouldTag": true
}
},
"metadataOptions": {"httpTokens": "optional",
"httpPutResponseHopLimit": "33"
},
"cpuOptions": {"threadsPerCore": "1"
},
"autoHealing": true
}
},
"scaling": {"up": [{"policyName": "my-up-policy",
"metricName": "CPUUtilization",
"statistic": "average",
"extendedStatistic": "p1.5",
"unit": "percent",
"threshold": 90,
"action": {"type": "updateCapacity",
"adjustment": 1,
"minTargetCapacity": 1,
"target": 1,
"minimum": 0,
"maximum": 5
},
"stepAdjustments": [{"action": {"type": "setMinTarget",
"adjustment": 2,
"minTargetCapacity": 3,
"target": 3,
"minimum": 4,
"maximum": 10
},
"threshold": 50
}
],
"namespace": "AWS/EC2",
"dimensions": [{"name": "InstanceId",
"value": "string"
}
],
"period": 300,
"evaluationPeriods": 1,
"cooldown": 300,
"operator": "gte",
"isEnabled": true
}
],
"down": [{"policyName": "my-down-policy",
"metricName": "CPUUtilization",
"statistic": "average",
"extendedStatistic": "p1.5",
"unit": "percent",
"threshold": 90,
"action": {"type": "updateCapacity",
"adjustment": 1,
"minTargetCapacity": 1,
"target": 1,
"minimum": 0,
"maximum": 5
},
"stepAdjustments": [{"action": {"type": "percentageAdjustment",
"adjustment": 40,
"maxTargetCapacity": 1,
"target": 2,
"minimum": 1,
"maximum": 5
},
"threshold": 10
}
],
"namespace": "AWS/EC2",
"dimensions": [{"name": "InstanceId",
"value": "string"
}
],
"period": 300,
"evaluationPeriods": 1,
"cooldown": 300,
"operator": "gte",
"isEnabled": true
}
],
"multipleMetrics": {"metrics": [{"name": "metric1",
"metricName": "CPUUtilization",
"namespace": "AWS/EC2",
"statistic": "average",
"extendedStatistic": "p1.5",
"unit": "percent",
"dimensions": [{"name": "InstanceId",
"value": "string"
}
]
}
],
"expressions": [{"name": "e1",
"expression": "metric1+10"
}
]
},
"target": [{"source": "spectrum",
"policyName": "my-up-policy",
"metricName": "CPUUtilization",
"statistic": "average",
"unit": "percent",
"namespace": "AWS/EC2",
"target": 1,
"cooldown": 300
}
]
},
"scheduling": {"tasks": [{"isEnabled": true,
"startTime": "2018-05-23T10:55:09Z",
"frequency": "hourly",
"cronExpression": "0 1 * * *",
"taskType": "scale",
"scaleTargetCapacity": 0,
"scaleMinCapacity": 0,
"scaleMaxCapacity": 0,
"targetCapacity": 0,
"MinCapacity": 0,
"MaxCapacity": 0,
"batchSizePercentage": 0
}
]
},
"thirdPartiesIntegration": {"rancher": {"masterHost": "http://myRancher.com:8080/v1",
"accessKey": "1",
"secretKey": "SECRET",
"version": 1
},
"kubernetes": {"integrationMode": "pod",
"clusterIdentifier": "test-k8s",
"autoScale": {"isEnabled": true,
"cooldown": 300,
"down": {"evaluationPeriods": 5,
"maxScaleDownPercentage": 70,
"headroom": {"cpuPerUnit": 2048,
"memoryPerUnit": 3,
"numOfUnits": 2,
"gpuPerUnit": 2
}
},
"labels": [{"key": "group, kops.k8s.io/instancegroup",
"value": "microservices"
}
],
"isAutoConfig": false
}
},
"mesosphere": {"apiServer": "1.2.3.4"
},
"mlbRuntime": {"deploymentId": "dp-rm0f5b912345"
},
"nomad": {"masterHost": "https://master.host.com",
"masterPort": 443,
"autoScale": {"isEnabled": true,
"cooldown": 180,
"down": {"evaluationPeriods": 3
},
"headroom": {"cpuPerUnit": 2048,
"memoryPerUnit": 3,
"numOfUnits": 2
},
"constraints": [{"key": "${node.class}",
"value": "value"
}
]
},
"aclToken": 123,
"tlsConfig": {"tlsEnabled": true,
"privateKey": "PRIVATE KEY CERTIFICATE STR",
"certificate": "PUBLIC KEY CERTIFICATE STR"
}
},
"chef": {"chefServer": "https://master.host.com",
"organization": "ORGNAME",
"chefVersion": 12.1,
"user": "User",
"pemKey": "Key"
},
"rightScale": {"accountId": "ID",
"refreshToken": "TOKEN",
"region": "us-east-1"
},
"opsWorks": {"layerId": "00d9m815-8aac-62b7-cc01-123456, xxxxxx-xxxxxxxx, xxxxxxx-xxxxxxxxxx",
"stackType": "CLASSIC"
},
"codeDeploy": {"cleanUpOnFailure": false,
"terminateInstanceOnFailure": false,
"deploymentGroups": [{"applicationName": "test-app",
"deploymentGroupName": "test-grp"
}
]
},
"route53": {"domains": [{"hostedZoneId": "Z3UFMBCGJMYLUT",
"spotinstAccountId": "act-1234abcd",
"recordSetType": "a",
"recordSets": [{"name": "testcname.spot.io.",
"usePublicIp": true,
"usePublicDns": true
}
]
}
]
},
"elasticBeanstalk": {"environmentId": "e-12345",
"deploymentPreferences": {"automaticRoll": true,
"batchSizePercentage": 50,
"gracePeriod": 600,
"strategy": {"action": "REPLACE_SERVER",
"shouldDrainInstances": true
}
},
"managedActions": {"platformUpdate": {"performAt": "timeWindow",
"timeWindow": "Mon:23:50-Tue:00:20",
"updateLevel": "patch",
"instanceRefreshEnabled": true
}
}
},
"ecs": {"clusterName": "test-ecs",
"autoScale": {"isEnabled": true,
"cooldown": 300,
"attributes": {"key": "the_key",
"value": "the_value"
},
"resourceLimits": {"maxMemoryGib": 1,
"maxVcpu": 1
},
"down": {"evaluationPeriods": 4,
"maxScaleDownPercentage": 20
},
"headroom": {"cpuPerUnit": 2048,
"memoryPerUnit": 3,
"numOfUnits": 2
},
"isAutoConfig": false,
"shouldScaleDownNonServiceTasks": true,
"enableAutomaticAndManualHeadroom": false
},
"batch": {"jobQueueNames": [["dumpy-big-processing"
]
]
},
"optimizeImages": {"shouldOptimizeEcsAmi": true,
"performAt": "timeWindow",
"timeWindows": ["Mon:03:00-Wed:02:30"
]
}
},
"dockerSwarm": {"masterHost": "swarm1.swarm.com",
"masterPort": 1234,
"autoScale": {"isEnabled": "true",
"cooldown": 300,
"down": {"evaluationPeriods": 4,
"maxScaleDownPercentage": 20
},
"headroom": {"cpuPerUnit": 1000,
"memoryPerUnit": 2048,
"numOfUnits": 3
},
"tlsConfig": {"tlsEnabled": true,
"privateKey": "PRIVATE KEY CERTIFICATE STR",
"certificate": "PUBLIC KEY CERTIFICATE STR"
}
}
},
"jenkins": {"connectionMethod": {"jnlp": {"masterIP": "210.4.5.1",
"masterPort": "8080",
"password": "foo",
"userName": "foo",
"token": "1234"
},
"ssh": {"sshPublicKey": "ssh-rsa AAAAB3NzaC1y..."
},
"manuallyConnection": "true"
}
}
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"group": {"name": "my-Elastigroup",
"description": "This Elastigroup is used for Development",
"region": "us-east-1",
"capacity": {"target": 1,
"minimum": 0,
"maximum": 10,
"unit": "instance"
},
"strategy": {"risk": 100,
"onDemandCount": 0,
"availabilityVsCost": "costOriented",
"fallbackToOd": true,
"utilizeReservedInstances": false,
"utilizeCommitments": false,
"drainingTimeout": 120,
"signals": [{"name": "INSTANCE_READY",
"timeout": 120
}
],
"persistence": [{"shouldPersistPrivateIp": true,
"shouldPersistRootDevice": true,
"shouldPersistBlockDevices": true,
"blockDevicesMode": "reattach"
}
],
"revertToSpot": {"performAt": "timeWindow",
"timeWindows": ["Mon:03:00-Wed:02:30"
]
},
"scalingStrategy": {"terminationPolicy": "default"
}
},
"compute": {"product": "Linux/UNIX",
"elasticIps": ["eipalloc-9d4e16f8"
],
"privateIps": ["172.1.1.1"
],
"instanceTypes": {"ondemand": "m3.medium",
"spot": [["c3.large",
"c4.large",
"m3.large",
"r3.large"
]
],
"preferredSpot": [["c4.large"
]
],
"weights": [{"instanceType": "c4.large",
"weightedCapacity": 8
}
]
},
"subnetIds": [["subnet-4c1d1538",
"subnet-2791bb61",
"subnet-703a6f58",
"subnet-c62846fc"
]
],
"availabilityZones": [{"name": "us-west-2a",
"subnetIds": [["subnet-4333093a"
]
],
"placementGroupName": "string"
}
],
"preferredAvailabilityZones": [["us-east-1a",
"us-east-1b"
]
],
"launchSpecification": {"creditSpecification": {"cpuCredits": "unlimited"
},
"loadBalancersConfig": {"loadBalancers": [{"name": "MyTargetGroup",
"arn": "arn:aws:elasticloadbalancing:us-west-2:922761411234:targetgroup/MyTargetGroup/1fe63217f8ff1234",
"type": "TARGET_GROUP",
"balancerId": "lb-123456789",
"targetSetId": "ts-123456789",
"azAwareness": false,
"autoWeight": true
}
]
},
"itf": {"fixedTargetGroups": false,
"weightStrategy": "custom",
"migrationHealthinessThreshold": 80,
"loadBalancers": [{"loadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188",
"listenerRules": [{"ruleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/0123456789012345/1234567890123456/234567890123456",
"staticTargetGroups": [{"arn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/blue-targets/73e2d6bc24d8a068",
"percentage": 0.5
}
]
}
],
"defaultStaticTargetGroups": [{"arn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/blue-targets/73e2d6bc24d8a067",
"percentage": 0.4
}
]
}
],
"targetGroupConfig": {"vpcId": "vpc-0410a20ec1702a537",
"healthCheckPath": "/index.html",
"healthCheckProtocol": "HTTP",
"healthCheckPort": "traffic-port",
"healthCheckIntervalSeconds": 40,
"healthCheckTimeoutSeconds": 20,
"healthyThresholdCount": 3,
"unhealthyThresholdCount": 4,
"port": 80,
"protocol": "HTTP",
"protocolVersion": "HTTP1",
"tags": [{"creator": "John Doe"
}
],
"matcher": {"httpCode": "200"
}
}
},
"healthCheckType": "EC2",
"healthCheckGracePeriod": 600,
"healthCheckUnhealthyDurationBeforeReplacement": 60,
"securityGroupIds": [["sg-0dfc2c8760df6fec7"
]
],
"monitoring": false,
"ebsOptimized": false,
"imageId": "ami-01e24be29428c15b2",
"images": [{"id": "ami-123456789"
}
],
"keyPair": "labs-oregon",
"blockDeviceMappings": [{"deviceName": "/dev/xvdcz",
"ebs": {"iops": 0,
"throughput": 125,
"volumeType": "gp2",
"deleteOnTermination": true,
"volumeSize": 12,
"dynamicVolumeSize": {"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
}
}
}
],
"networkInterfaces": [{"description": "string",
"deviceIndex": 0,
"secondaryPrivateIpAddressCount": 0,
"associatePublicIpAddress": true,
"deleteOnTermination": true,
"networkInterfaceId": "string",
"privateIpAddresses": [{"privateIpAddress": "string",
"primary": true
}
],
"subnetId": "string",
"associateIpv6Address": true
}
],
"iamRole": {"name": "my-iamRole"
},
"userData": "dXNlcmJhc2g2NGVuY29kZWQ=",
"shutdownScript": "dXNlcmJhc2g2NGVuY29kZWQ=",
"tags": [{"tagKey": "Creator",
"tagValue": "John Doe"
}
],
"metadataOptions": {"httpTokens": "optional",
"httpPutResponseHopLimit": "33"
},
"cpuOptions": {"threadsPerCore": "1"
},
"resourceTagSpecification": {"volumes": {"shouldTag": false
},
"snapshots": {"shouldTag": true
},
"enis": {"shouldTag": false
},
"amis": {"shouldTag": true
}
},
"autoHealing": true
}
},
"scaling": {"up": [{"policyName": "my-up-policy",
"metricName": "CPUUtilization",
"statistic": "average",
"extendedStatistic": "p1.5",
"unit": "percent",
"threshold": 90,
"action": {"type": "updateCapacity",
"adjustment": 1,
"minTargetCapacity": 1,
"target": 1,
"minimum": 0,
"maximum": 5
},
"stepAdjustments": [{"action": {"type": "setMinTarget",
"adjustment": 2,
"minTargetCapacity": 3,
"target": 3,
"minimum": 4,
"maximum": 10
},
"threshold": 50
}
],
"namespace": "AWS/EC2",
"dimensions": [{"name": "InstanceId",
"value": "string"
}
],
"period": 300,
"evaluationPeriods": 1,
"cooldown": 300,
"operator": "gte",
"isEnabled": true
}
],
"down": [{"policyName": "my-down-policy",
"metricName": "CPUUtilization",
"statistic": "average",
"extendedStatistic": "p1.5",
"unit": "percent",
"threshold": 90,
"action": {"type": "updateCapacity",
"adjustment": 1,
"minTargetCapacity": 1,
"target": 1,
"minimum": 0,
"maximum": 5
},
"stepAdjustments": [{"action": {"type": "percentageAdjustment",
"adjustment": 40,
"maxTargetCapacity": 1,
"target": 2,
"minimum": 1,
"maximum": 5
},
"threshold": 10
}
],
"namespace": "AWS/EC2",
"dimensions": [{"name": "InstanceId",
"value": "string"
}
],
"period": 300,
"evaluationPeriods": 1,
"cooldown": 300,
"operator": "gte",
"isEnabled": true
}
],
"multipleMetrics": {"metrics": [{"name": "metric1",
"metricName": "CPUUtilization",
"namespace": "AWS/EC2",
"statistic": "average",
"extendedStatistic": "p1.5",
"unit": "percent",
"dimensions": [{"name": "InstanceId",
"value": "string"
}
]
}
],
"expressions": [{"name": "e1",
"expression": "metric1+10"
}
]
},
"target": [{"source": "spectrum",
"policyName": "my-up-policy",
"metricName": "CPUUtilization",
"statistic": "average",
"unit": "percent",
"namespace": "AWS/EC2",
"target": 1,
"cooldown": 300
}
]
},
"scheduling": {"tasks": [{"isEnabled": true,
"startTime": "2018-05-23T10:55:09Z",
"frequency": "hourly",
"cronExpression": "0 1 * * *",
"taskType": "scale",
"scaleTargetCapacity": 0,
"scaleMinCapacity": 0,
"scaleMaxCapacity": 0,
"targetCapacity": 0,
"MinCapacity": 0,
"MaxCapacity": 0,
"batchSizePercentage": 0
}
]
},
"thirdPartiesIntegration": {"ecs": {"clusterName": "test-ecs",
"autoScale": {"isEnabled": true,
"cooldown": 300,
"attributes": {"key": "the_key",
"value": "the_value"
},
"resourceLimits": {"maxMemoryGib": 1,
"maxVcpu": 1
},
"down": {"evaluationPeriods": 4,
"maxScaleDownPercentage": 20
},
"headroom": {"cpuPerUnit": 2048,
"memoryPerUnit": 3,
"numOfUnits": 2
},
"isAutoConfig": false,
"shouldScaleDownNonServiceTasks": true,
"enableAutomaticAndManualHeadroom": false
},
"batch": {"jobQueueNames": [["dumpy-big-processing"
]
]
},
"optimizeImages": {"shouldOptimizeEcsAmi": true,
"performAt": "timeWindow",
"timeWindows": ["Mon:03:00-Wed:02:30"
]
}
},
"rancher": {"masterHost": "http://myRancher.com:8080/v1",
"accessKey": "1",
"secretKey": "SECRET",
"version": 1
},
"kubernetes": {"integrationMode": "pod",
"clusterIdentifier": "test-k8s",
"autoScale": {"isEnabled": true,
"cooldown": 300,
"down": {"evaluationPeriods": 5,
"maxScaleDownPercentage": 70,
"headroom": {"cpuPerUnit": 2048,
"memoryPerUnit": 3,
"numOfUnits": 2,
"gpuPerUnit": 2
}
},
"labels": [{"key": "group, kops.k8s.io/instancegroup",
"value": "microservices"
}
],
"isAutoConfig": false
}
},
"mesosphere": {"apiServer": "1.2.3.4"
},
"mlbRuntime": {"deploymentId": "dp-rm0f5b912345"
},
"nomad": {"masterHost": "https://master.host.com",
"masterPort": 443,
"autoScale": {"isEnabled": true,
"cooldown": 180,
"down": {"evaluationPeriods": 3
},
"headroom": {"cpuPerUnit": 2048,
"memoryPerUnit": 3,
"numOfUnits": 2
},
"constraints": [{"key": "${node.class}",
"value": "value"
}
]
},
"aclToken": 123,
"tlsConfig": {"tlsEnabled": true,
"privateKey": "PRIVATE KEY CERTIFICATE STR",
"certificate": "PUBLIC KEY CERTIFICATE STR"
}
},
"chef": {"chefServer": "https://master.host.com",
"organization": "ORGNAME",
"chefVersion": 12.1,
"user": "User",
"pemKey": "Key"
},
"rightScale": {"accountId": "ID",
"refreshToken": "TOKEN",
"region": "us-east-1"
},
"route53": {"domains": [{"hostedZoneId": "Z3UFMBCGJMYLUT",
"spotinstAccountId": "act-1234abcd",
"recordSetType": "a",
"recordSets": [{"name": "testcname.spot.io.",
"usePublicIp": true,
"usePublicDns": true
}
]
}
]
},
"dockerSwarm": {"masterHost": "swarm1.swarm.com",
"masterPort": 1234,
"autoScale": {"isEnabled": "true",
"cooldown": 300,
"down": {"evaluationPeriods": 4,
"maxScaleDownPercentage": 20
},
"headroom": {"cpuPerUnit": 1000,
"memoryPerUnit": 2048,
"numOfUnits": 3
},
"tlsConfig": {"tlsEnabled": true,
"privateKey": "PRIVATE KEY CERTIFICATE STR",
"certificate": "PUBLIC KEY CERTIFICATE STR"
}
}
},
"jenkins": {"connectionMethod": {"jnlp": {"masterIP": "210.4.5.1",
"masterPort": "8080",
"password": "foo",
"userName": "foo",
"token": "1234"
},
"ssh": {"sshPublicKey": "ssh-rsa AAAAB3NzaC1y..."
},
"manuallyConnection": "true"
}
}
},
"createdAt": "2020-10-01T05:23:59.302Z",
"updatedAt": "2020-10-01T05:23:59.302Z"
}
}
],
"count": 1,
"kind": "spotinst:aws:ec2:group"
}
}

List All Elastigroups

List all AWS Elastigroups for a Spot Account

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "67582d0c-108b-4ef7-9fdc-d39678a30844",
"url": "/aws/ec2/group",
"method": "GET",
"timestamp": "2018-01-07T07:30:58.622Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:aws:ec2:group",
"items": [[{"id": "sig-1234567",
"name": "EG name",
"description": "validation",
"capacity": {"minimum": 1,
"maximum": 1,
"target": 1,
"unit": "instance"
},
"strategy": {"risk": 0,
"onDemandCount": null,
"availabilityVsCost": "balanced"
},
"compute": {"instanceTypes": {"ondemand": "m3.large",
"spot": ["c3.large m3.large"
]
},
"availabilityZones": {"name": "us-west-2a",
"subnetIds": ["subnet-1234567"
]
},
"product": "Linux/UNIX",
"launchSpecification": {"securityGroupIds": ["sg-1234567"
],
"monitoring": true,
"imageId": "ami-987654",
"keyPair": "keyp",
"userData": null
}
},
"scaling": {"up": {"policyName": "up Scaling Policy 1",
"metricName": "CPUUtilization",
"statistic": "maximum",
"unit": "percent",
"threshold": 90,
"adjustment": 2,
"namespace": "AWS/EC2",
"period": 300,
"evaluationPeriods": 3,
"cooldown": 60
},
"down": {"policyName": "down Scaling Policy 1",
"metricName": "CPUUtilization",
"statistic": "maximum",
"unit": "percent",
"threshold": 50,
"adjustment": 2,
"namespace": "AWS/EC2",
"period": 300,
"evaluationPeriods": 3,
"cooldown": 60,
"dimensions": [{"name": "InstanceId"
}
]
}
},
"scheduling": {"tasks": [{"frequency": "weekly",
"taskType": "backup_ami"
}
]
},
"thirdPartiesIntegration": { },
"createdAt": "2016-02-16T09:03:23.000Z",
"updatedAt": "2018-01-07T00:10:30.000Z"
},
{"id": "sig-897654",
"name": "Test EG",
"description": "Test",
"capacity": {"minimum": 0,
"maximum": 0,
"target": 0,
"unit": "instance"
},
"strategy": {"risk": 100,
"onDemandCount": null,
"availabilityVsCost": "balanced"
},
"compute": {"instanceTypes": {"ondemand": "m3.large",
"spot": ["m3.large c3.large"
]
},
"availabilityZones": {"name": "us-west-2b",
"subnetIds": ["subnet-657493"
]
},
"product": "Linux/UNIX",
"launchSpecification": {"securityGroupIds": ["sg-987126"
],
"monitoring": true,
"imageId": "ami-87236464",
"keyPair": "PairKey",
"userData": null
}
},
"scaling": {"up": {"policyName": "up Scaling Policy 1",
"metricName": "CPUUtilization",
"statistic": "maximum",
"unit": "percent",
"stepAdjustments": [{"action": {"adjustment": "3",
"type": "adjustment"
},
"threshold": 30
}
],
"namespace": "AWS/EC2",
"period": 300,
"evaluationPeriods": 3,
"cooldown": 60
},
"down": {"policyName": "down Scaling Policy 1",
"metricName": "CPUUtilization",
"statistic": "maximum",
"unit": "percent",
"threshold": 50,
"adjustment": 2,
"namespace": "AWS/EC2",
"period": 300,
"evaluationPeriods": 3,
"cooldown": 60,
"dimensions": [{"name": "InstanceId"
}
]
}
},
"scheduling": {"tasks": [{"frequency": "weekly",
"taskType": "backup_ami"
}
]
},
"thirdPartiesIntegration": { },
"createdAt": "2016-02-16T06:35:03.000Z",
"updatedAt": "2016-02-16T10:21:01.000Z"
}
]
],
"count": 2
}
}

Update Elastigroup

Describe a specific Elastigroup JSON

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

The Spot Elastigroup ID you want to update

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
autoApplyTags	boolean Default: false Example: autoApplyTags=true Optionally update resource tags on the fly without performing a roll.

Request Body schema: application/json

required

object

Group

	object (Elastigroup Capacity)
	object (Elastigroup Compute)
description	string Describe your AWS Elastigroup
name	string AWS Elastigroup Name
region	string The AWS region your group will be created in. This parameter is required if you specify subnets (through compute.subnetIds). This parameter is optional if you specify Availability Zones (through compute.availabilityZones).
	object (Elastigroup Scaling)
	object (Elastigroup Scheduling) Schedule tasks to execute, using CRON expressions.
	object (Elastigroup Strategy)
	object (Elastigroup Third Party Integrations) All definitions for using third-party Integrations

Responses

Request samples

Payload

Content type

application/json

{"group": {"name": "my-Elastigroup",
"description": "This Elastigroup is used for Development",
"region": "us-east-1",
"capacity": {"target": 1,
"minimum": 0,
"maximum": 10
},
"strategy": {"risk": 100,
"onDemandCount": 0,
"availabilityVsCost": "costOriented",
"fallbackToOd": true,
"utilizeReservedInstances": false,
"utilizeCommitments": false,
"drainingTimeout": 120,
"signals": [{"name": "INSTANCE_READY",
"timeout": 120
}
],
"persistence": [{"shouldPersistPrivateIp": true,
"shouldPersistRootDevice": true,
"shouldPersistBlockDevices": true,
"blockDevicesMode": "reattach"
}
],
"revertToSpot": {"performAt": "timeWindow",
"timeWindows": ["Mon:03:00-Wed:02:30"
]
},
"scalingStrategy": {"terminationPolicy": "default"
}
},
"compute": {"elasticIps": ["eipalloc-9d4e16f8"
],
"privateIps": ["172.1.1.1"
],
"instanceTypes": {"ondemand": "m3.medium",
"spot": [["c3.large",
"c4.large",
"m3.large",
"r3.large"
]
],
"preferredSpot": [["c4.large"
]
],
"weights": [{"instanceType": "c4.large",
"weightedCapacity": 8
}
]
},
"subnetIds": [["subnet-4c1d1538",
"subnet-2791bb61",
"subnet-703a6f58",
"subnet-c62846fc"
]
],
"availabilityZones": [{"name": "us-west-2a",
"subnetIds": [["subnet-4333093a"
]
],
"placementGroupName": "string"
}
],
"preferredAvailabilityZones": [["us-east-1a",
"us-east-1b"
]
],
"launchSpecification": {"creditSpecification": {"cpuCredits": "unlimited"
},
"loadBalancersConfig": {"loadBalancers": [{"name": "MyTargetGroup",
"arn": "arn:aws:elasticloadbalancing:us-west-2:922761411234:targetgroup/MyTargetGroup/1fe63217f8ff1234",
"type": "TARGET_GROUP",
"balancerId": "lb-123456789",
"targetSetId": "ts-123456789",
"azAwareness": false,
"autoWeight": true
}
]
},
"itf": {"fixedTargetGroups": false,
"weightStrategy": "custom",
"migrationHealthinessThreshold": 80,
"loadBalancers": [{"loadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188",
"listenerRules": [{"ruleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/0123456789012345/1234567890123456/234567890123456",
"staticTargetGroups": [{"arn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/blue-targets/73e2d6bc24d8a068",
"percentage": 0.5
}
]
}
],
"defaultStaticTargetGroups": [{"arn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/blue-targets/73e2d6bc24d8a067",
"percentage": 0.4
}
]
}
],
"targetGroupConfig": {"vpcId": "vpc-0410a20ec1702a537",
"healthCheckPath": "/index.html",
"healthCheckProtocol": "HTTP",
"healthCheckPort": "traffic-port",
"healthCheckIntervalSeconds": 40,
"healthCheckTimeoutSeconds": 20,
"healthyThresholdCount": 3,
"unhealthyThresholdCount": 4,
"port": 80,
"protocol": "HTTP",
"protocolVersion": "HTTP1",
"tags": [{"creator": "John Doe"
}
],
"matcher": {"httpCode": "200"
}
}
},
"healthCheckType": "EC2",
"healthCheckGracePeriod": 600,
"healthCheckUnhealthyDurationBeforeReplacement": 60,
"securityGroupIds": [["sg-0dfc2c8760df6fec7"
]
],
"monitoring": false,
"ebsOptimized": false,
"imageId": "ami-01e24be29428c15b2",
"images": [{"id": "ami-123456789"
}
],
"keyPair": "labs-oregon",
"blockDeviceMappings": [{"deviceName": "/dev/xvdcz",
"ebs": {"iops": 0,
"throughput": 125,
"volumeType": "gp2",
"deleteOnTermination": true,
"volumeSize": 12,
"dynamicVolumeSize": {"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
}
}
}
],
"networkInterfaces": [{"description": "string",
"deviceIndex": 0,
"secondaryPrivateIpAddressCount": 0,
"associatePublicIpAddress": true,
"deleteOnTermination": true,
"networkInterfaceId": "string",
"privateIpAddresses": [{"privateIpAddress": "string",
"primary": true
}
],
"subnetId": "string",
"associateIpv6Address": true
}
],
"iamRole": {"name": "my-iamRole"
},
"userData": "dXNlcmJhc2g2NGVuY29kZWQ=",
"shutdownScript": "dXNlcmJhc2g2NGVuY29kZWQ=",
"tags": [{"tagKey": "Creator",
"tagValue": "John Doe"
}
],
"metadataOptions": {"httpTokens": "optional",
"httpPutResponseHopLimit": "33"
},
"cpuOptions": {"threadsPerCore": "1"
},
"resourceTagSpecification": {"volumes": {"shouldTag": false
},
"snapshots": {"shouldTag": true
},
"enis": {"shouldTag": false
},
"amis": {"shouldTag": true
}
},
"autoHealing": true
}
},
"scaling": {"up": [{"policyName": "my-up-policy",
"metricName": "CPUUtilization",
"statistic": "average",
"extendedStatistic": "p1.5",
"unit": "percent",
"threshold": 90,
"action": {"type": "updateCapacity",
"adjustment": 1,
"minTargetCapacity": 1,
"target": 1,
"minimum": 0,
"maximum": 5
},
"stepAdjustments": [{"action": {"type": "setMinTarget",
"adjustment": 2,
"minTargetCapacity": 3,
"target": 3,
"minimum": 4,
"maximum": 10
},
"threshold": 50
}
],
"namespace": "AWS/EC2",
"dimensions": [{"name": "InstanceId",
"value": "string"
}
],
"period": 300,
"evaluationPeriods": 1,
"cooldown": 300,
"operator": "gte",
"isEnabled": true
}
],
"down": [{"policyName": "my-down-policy",
"metricName": "CPUUtilization",
"statistic": "average",
"extendedStatistic": "p1.5",
"unit": "percent",
"threshold": 90,
"action": {"type": "updateCapacity",
"adjustment": 1,
"minTargetCapacity": 1,
"target": 1,
"minimum": 0,
"maximum": 5
},
"stepAdjustments": [{"action": {"type": "percentageAdjustment",
"adjustment": 40,
"maxTargetCapacity": 1,
"target": 2,
"minimum": 1,
"maximum": 5
},
"threshold": 10
}
],
"namespace": "AWS/EC2",
"dimensions": [{"name": "InstanceId",
"value": "string"
}
],
"period": 300,
"evaluationPeriods": 1,
"cooldown": 300,
"operator": "gte",
"isEnabled": true
}
],
"multipleMetrics": {"metrics": [{"name": "metric1",
"metricName": "CPUUtilization",
"namespace": "AWS/EC2",
"statistic": "average",
"extendedStatistic": "p1.5",
"unit": "percent",
"dimensions": [{"name": "InstanceId",
"value": "string"
}
]
}
],
"expressions": [{"name": "e1",
"expression": "metric1+10"
}
]
},
"target": [{"source": "spectrum",
"policyName": "my-up-policy",
"metricName": "CPUUtilization",
"statistic": "average",
"unit": "percent",
"namespace": "AWS/EC2",
"target": 1,
"cooldown": 300
}
]
},
"scheduling": {"tasks": [{"isEnabled": true,
"startTime": "2018-05-23T10:55:09Z",
"frequency": "hourly",
"cronExpression": "0 1 * * *",
"taskType": "scale",
"scaleTargetCapacity": 0,
"scaleMinCapacity": 0,
"scaleMaxCapacity": 0,
"targetCapacity": 0,
"MinCapacity": 0,
"MaxCapacity": 0,
"batchSizePercentage": 0
}
]
},
"thirdPartiesIntegration": {"ecs": {"clusterName": "test-ecs",
"autoScale": {"isEnabled": true,
"cooldown": 300,
"attributes": {"key": "the_key",
"value": "the_value"
},
"resourceLimits": {"maxMemoryGib": 1,
"maxVcpu": 1
},
"down": {"evaluationPeriods": 4,
"maxScaleDownPercentage": 20
},
"headroom": {"cpuPerUnit": 2048,
"memoryPerUnit": 3,
"numOfUnits": 2
},
"isAutoConfig": false,
"shouldScaleDownNonServiceTasks": true,
"enableAutomaticAndManualHeadroom": false
},
"batch": {"jobQueueNames": [["dumpy-big-processing"
]
]
},
"optimizeImages": {"shouldOptimizeEcsAmi": true,
"performAt": "timeWindow",
"timeWindows": ["Mon:03:00-Wed:02:30"
]
}
},
"rancher": {"masterHost": "http://myRancher.com:8080/v1",
"accessKey": "1",
"secretKey": "SECRET",
"version": 1
},
"kubernetes": {"integrationMode": "pod",
"clusterIdentifier": "test-k8s",
"autoScale": {"isEnabled": true,
"cooldown": 300,
"down": {"evaluationPeriods": 5,
"maxScaleDownPercentage": 70,
"headroom": {"cpuPerUnit": 2048,
"memoryPerUnit": 3,
"numOfUnits": 2,
"gpuPerUnit": 2
}
},
"labels": [{"key": "group, kops.k8s.io/instancegroup",
"value": "microservices"
}
],
"isAutoConfig": false
}
},
"mesosphere": {"apiServer": "1.2.3.4"
},
"mlbRuntime": {"deploymentId": "dp-rm0f5b912345"
},
"nomad": {"masterHost": "https://master.host.com",
"masterPort": 443,
"autoScale": {"isEnabled": true,
"cooldown": 180,
"down": {"evaluationPeriods": 3
},
"headroom": {"cpuPerUnit": 2048,
"memoryPerUnit": 3,
"numOfUnits": 2
},
"constraints": [{"key": "${node.class}",
"value": "value"
}
]
},
"aclToken": 123,
"tlsConfig": {"tlsEnabled": true,
"privateKey": "PRIVATE KEY CERTIFICATE STR",
"certificate": "PUBLIC KEY CERTIFICATE STR"
}
},
"chef": {"chefServer": "https://master.host.com",
"organization": "ORGNAME",
"chefVersion": 12.1,
"user": "User",
"pemKey": "Key"
},
"rightScale": {"accountId": "ID",
"refreshToken": "TOKEN",
"region": "us-east-1"
},
"route53": {"domains": [{"hostedZoneId": "Z3UFMBCGJMYLUT",
"spotinstAccountId": "act-1234abcd",
"recordSetType": "a",
"recordSets": [{"name": "testcname.spot.io.",
"usePublicIp": true,
"usePublicDns": true
}
]
}
]
},
"dockerSwarm": {"masterHost": "swarm1.swarm.com",
"masterPort": 1234,
"autoScale": {"isEnabled": "true",
"cooldown": 300,
"down": {"evaluationPeriods": 4,
"maxScaleDownPercentage": 20
},
"headroom": {"cpuPerUnit": 1000,
"memoryPerUnit": 2048,
"numOfUnits": 3
},
"tlsConfig": {"tlsEnabled": true,
"privateKey": "PRIVATE KEY CERTIFICATE STR",
"certificate": "PUBLIC KEY CERTIFICATE STR"
}
}
},
"jenkins": {"connectionMethod": {"jnlp": {"masterIP": "210.4.5.1",
"masterPort": "8080",
"password": "foo",
"userName": "foo",
"token": "1234"
},
"ssh": {"sshPublicKey": "ssh-rsa AAAAB3NzaC1y..."
},
"manuallyConnection": "true"
}
}
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"group": {"name": "my-Elastigroup",
"description": "This Elastigroup is used for Development",
"region": "us-east-1",
"capacity": {"target": 1,
"minimum": 0,
"maximum": 10,
"unit": "instance"
},
"strategy": {"risk": 100,
"onDemandCount": 0,
"availabilityVsCost": "costOriented",
"fallbackToOd": true,
"utilizeReservedInstances": false,
"utilizeCommitments": false,
"drainingTimeout": 120,
"signals": [{"name": "INSTANCE_READY",
"timeout": 120
}
],
"persistence": [{"shouldPersistPrivateIp": true,
"shouldPersistRootDevice": true,
"shouldPersistBlockDevices": true,
"blockDevicesMode": "reattach"
}
],
"revertToSpot": {"performAt": "timeWindow",
"timeWindows": ["Mon:03:00-Wed:02:30"
]
},
"scalingStrategy": {"terminationPolicy": "default"
}
},
"compute": {"product": "Linux/UNIX",
"elasticIps": ["eipalloc-9d4e16f8"
],
"privateIps": ["172.1.1.1"
],
"instanceTypes": {"ondemand": "m3.medium",
"spot": [["c3.large",
"c4.large",
"m3.large",
"r3.large"
]
],
"preferredSpot": [["c4.large"
]
],
"weights": [{"instanceType": "c4.large",
"weightedCapacity": 8
}
]
},
"subnetIds": [["subnet-4c1d1538",
"subnet-2791bb61",
"subnet-703a6f58",
"subnet-c62846fc"
]
],
"availabilityZones": [{"name": "us-west-2a",
"subnetIds": [["subnet-4333093a"
]
],
"placementGroupName": "string"
}
],
"preferredAvailabilityZones": [["us-east-1a",
"us-east-1b"
]
],
"launchSpecification": {"creditSpecification": {"cpuCredits": "unlimited"
},
"loadBalancersConfig": {"loadBalancers": [{"name": "MyTargetGroup",
"arn": "arn:aws:elasticloadbalancing:us-west-2:922761411234:targetgroup/MyTargetGroup/1fe63217f8ff1234",
"type": "TARGET_GROUP",
"balancerId": "lb-123456789",
"targetSetId": "ts-123456789",
"azAwareness": false,
"autoWeight": true
}
]
},
"itf": {"fixedTargetGroups": false,
"weightStrategy": "custom",
"migrationHealthinessThreshold": 80,
"loadBalancers": [{"loadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188",
"listenerRules": [{"ruleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/0123456789012345/1234567890123456/234567890123456",
"staticTargetGroups": [{"arn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/blue-targets/73e2d6bc24d8a068",
"percentage": 0.5
}
]
}
],
"defaultStaticTargetGroups": [{"arn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/blue-targets/73e2d6bc24d8a067",
"percentage": 0.4
}
]
}
],
"targetGroupConfig": {"vpcId": "vpc-0410a20ec1702a537",
"healthCheckPath": "/index.html",
"healthCheckProtocol": "HTTP",
"healthCheckPort": "traffic-port",
"healthCheckIntervalSeconds": 40,
"healthCheckTimeoutSeconds": 20,
"healthyThresholdCount": 3,
"unhealthyThresholdCount": 4,
"port": 80,
"protocol": "HTTP",
"protocolVersion": "HTTP1",
"tags": [{"creator": "John Doe"
}
],
"matcher": {"httpCode": "200"
}
}
},
"healthCheckType": "EC2",
"healthCheckGracePeriod": 600,
"healthCheckUnhealthyDurationBeforeReplacement": 60,
"securityGroupIds": [["sg-0dfc2c8760df6fec7"
]
],
"monitoring": false,
"ebsOptimized": false,
"imageId": "ami-01e24be29428c15b2",
"images": [{"id": "ami-123456789"
}
],
"keyPair": "labs-oregon",
"blockDeviceMappings": [{"deviceName": "/dev/xvdcz",
"ebs": {"iops": 0,
"throughput": 125,
"volumeType": "gp2",
"deleteOnTermination": true,
"volumeSize": 12,
"dynamicVolumeSize": {"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
}
}
}
],
"networkInterfaces": [{"description": "string",
"deviceIndex": 0,
"secondaryPrivateIpAddressCount": 0,
"associatePublicIpAddress": true,
"deleteOnTermination": true,
"networkInterfaceId": "string",
"privateIpAddresses": [{"privateIpAddress": "string",
"primary": true
}
],
"subnetId": "string",
"associateIpv6Address": true
}
],
"iamRole": {"name": "my-iamRole"
},
"userData": "dXNlcmJhc2g2NGVuY29kZWQ=",
"shutdownScript": "dXNlcmJhc2g2NGVuY29kZWQ=",
"tags": [{"tagKey": "Creator",
"tagValue": "John Doe"
}
],
"metadataOptions": {"httpTokens": "optional",
"httpPutResponseHopLimit": "33"
},
"cpuOptions": {"threadsPerCore": "1"
},
"resourceTagSpecification": {"volumes": {"shouldTag": false
},
"snapshots": {"shouldTag": true
},
"enis": {"shouldTag": false
},
"amis": {"shouldTag": true
}
},
"autoHealing": true
}
},
"scaling": {"up": [{"policyName": "my-up-policy",
"metricName": "CPUUtilization",
"statistic": "average",
"extendedStatistic": "p1.5",
"unit": "percent",
"threshold": 90,
"action": {"type": "updateCapacity",
"adjustment": 1,
"minTargetCapacity": 1,
"target": 1,
"minimum": 0,
"maximum": 5
},
"stepAdjustments": [{"action": {"type": "setMinTarget",
"adjustment": 2,
"minTargetCapacity": 3,
"target": 3,
"minimum": 4,
"maximum": 10
},
"threshold": 50
}
],
"namespace": "AWS/EC2",
"dimensions": [{"name": "InstanceId",
"value": "string"
}
],
"period": 300,
"evaluationPeriods": 1,
"cooldown": 300,
"operator": "gte",
"isEnabled": true
}
],
"down": [{"policyName": "my-down-policy",
"metricName": "CPUUtilization",
"statistic": "average",
"extendedStatistic": "p1.5",
"unit": "percent",
"threshold": 90,
"action": {"type": "updateCapacity",
"adjustment": 1,
"minTargetCapacity": 1,
"target": 1,
"minimum": 0,
"maximum": 5
},
"stepAdjustments": [{"action": {"type": "percentageAdjustment",
"adjustment": 40,
"maxTargetCapacity": 1,
"target": 2,
"minimum": 1,
"maximum": 5
},
"threshold": 10
}
],
"namespace": "AWS/EC2",
"dimensions": [{"name": "InstanceId",
"value": "string"
}
],
"period": 300,
"evaluationPeriods": 1,
"cooldown": 300,
"operator": "gte",
"isEnabled": true
}
],
"multipleMetrics": {"metrics": [{"name": "metric1",
"metricName": "CPUUtilization",
"namespace": "AWS/EC2",
"statistic": "average",
"extendedStatistic": "p1.5",
"unit": "percent",
"dimensions": [{"name": "InstanceId",
"value": "string"
}
]
}
],
"expressions": [{"name": "e1",
"expression": "metric1+10"
}
]
},
"target": [{"source": "spectrum",
"policyName": "my-up-policy",
"metricName": "CPUUtilization",
"statistic": "average",
"unit": "percent",
"namespace": "AWS/EC2",
"target": 1,
"cooldown": 300
}
]
},
"scheduling": {"tasks": [{"isEnabled": true,
"startTime": "2018-05-23T10:55:09Z",
"frequency": "hourly",
"cronExpression": "0 1 * * *",
"taskType": "scale",
"scaleTargetCapacity": 0,
"scaleMinCapacity": 0,
"scaleMaxCapacity": 0,
"targetCapacity": 0,
"MinCapacity": 0,
"MaxCapacity": 0,
"batchSizePercentage": 0
}
]
},
"thirdPartiesIntegration": {"ecs": {"clusterName": "test-ecs",
"autoScale": {"isEnabled": true,
"cooldown": 300,
"attributes": {"key": "the_key",
"value": "the_value"
},
"resourceLimits": {"maxMemoryGib": 1,
"maxVcpu": 1
},
"down": {"evaluationPeriods": 4,
"maxScaleDownPercentage": 20
},
"headroom": {"cpuPerUnit": 2048,
"memoryPerUnit": 3,
"numOfUnits": 2
},
"isAutoConfig": false,
"shouldScaleDownNonServiceTasks": true,
"enableAutomaticAndManualHeadroom": false
},
"batch": {"jobQueueNames": [["dumpy-big-processing"
]
]
},
"optimizeImages": {"shouldOptimizeEcsAmi": true,
"performAt": "timeWindow",
"timeWindows": ["Mon:03:00-Wed:02:30"
]
}
},
"rancher": {"masterHost": "http://myRancher.com:8080/v1",
"accessKey": "1",
"secretKey": "SECRET",
"version": 1
},
"kubernetes": {"integrationMode": "pod",
"clusterIdentifier": "test-k8s",
"autoScale": {"isEnabled": true,
"cooldown": 300,
"down": {"evaluationPeriods": 5,
"maxScaleDownPercentage": 70,
"headroom": {"cpuPerUnit": 2048,
"memoryPerUnit": 3,
"numOfUnits": 2,
"gpuPerUnit": 2
}
},
"labels": [{"key": "group, kops.k8s.io/instancegroup",
"value": "microservices"
}
],
"isAutoConfig": false
}
},
"mesosphere": {"apiServer": "1.2.3.4"
},
"mlbRuntime": {"deploymentId": "dp-rm0f5b912345"
},
"nomad": {"masterHost": "https://master.host.com",
"masterPort": 443,
"autoScale": {"isEnabled": true,
"cooldown": 180,
"down": {"evaluationPeriods": 3
},
"headroom": {"cpuPerUnit": 2048,
"memoryPerUnit": 3,
"numOfUnits": 2
},
"constraints": [{"key": "${node.class}",
"value": "value"
}
]
},
"aclToken": 123,
"tlsConfig": {"tlsEnabled": true,
"privateKey": "PRIVATE KEY CERTIFICATE STR",
"certificate": "PUBLIC KEY CERTIFICATE STR"
}
},
"chef": {"chefServer": "https://master.host.com",
"organization": "ORGNAME",
"chefVersion": 12.1,
"user": "User",
"pemKey": "Key"
},
"rightScale": {"accountId": "ID",
"refreshToken": "TOKEN",
"region": "us-east-1"
},
"route53": {"domains": [{"hostedZoneId": "Z3UFMBCGJMYLUT",
"spotinstAccountId": "act-1234abcd",
"recordSetType": "a",
"recordSets": [{"name": "testcname.spot.io.",
"usePublicIp": true,
"usePublicDns": true
}
]
}
]
},
"dockerSwarm": {"masterHost": "swarm1.swarm.com",
"masterPort": 1234,
"autoScale": {"isEnabled": "true",
"cooldown": 300,
"down": {"evaluationPeriods": 4,
"maxScaleDownPercentage": 20
},
"headroom": {"cpuPerUnit": 1000,
"memoryPerUnit": 2048,
"numOfUnits": 3
},
"tlsConfig": {"tlsEnabled": true,
"privateKey": "PRIVATE KEY CERTIFICATE STR",
"certificate": "PUBLIC KEY CERTIFICATE STR"
}
}
},
"jenkins": {"connectionMethod": {"jnlp": {"masterIP": "210.4.5.1",
"masterPort": "8080",
"password": "foo",
"userName": "foo",
"token": "1234"
},
"ssh": {"sshPublicKey": "ssh-rsa AAAAB3NzaC1y..."
},
"manuallyConnection": "true"
}
}
},
"createdAt": "2020-10-01T05:23:59.302Z",
"updatedAt": "2020-10-01T05:23:59.302Z"
}
}
],
"count": 1,
"kind": "spotinst:aws:ec2:group"
}
}

Delete Elastigroup

Delete an Elastigroup AWS

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

The Spot Elastigroup ID you want to update

query Parameters

accountId

string

Example: accountId=act-123abc

ID of the account associated with your token

Request Body schema: application/json

	object (AMI Dellocation Options)
	object (Beanstalk Dellocation Options)
	object (Stateful deallocation options)

Responses

Request samples

Payload

Content type

application/json

{"statefulDeallocation": {"shouldDeleteImages": false,
"shouldDeleteNetworkInterfaces": true,
"shouldDeleteVolumes": false,
"shouldDeleteSnapshots": false
},
"beanstalk": {"rollbackToAsg": true
},
"amiBackup": {"shouldDeleteImages": false
}
}

Response samples

Content type

application/json

{"request": {"id": "3b750eff-3940-46b3-a309-aa2b415272fd",
"url": "/aws/ec2/group/sig-98765",
"method": "DELETE",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

List Elastigroup

Describe a specific Elastigroup JSON

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

The Spot Elastigroup ID you want to update

query Parameters

accountId

string

Example: accountId=act-123456789

ID of the account associated with your token

Responses

Response samples

Content type

application/json

{"request": {"id": "67582d0c-108b-4ef7-9fdc-d39678a30844",
"url": "/aws/ec2/group/sig-1234567",
"method": "GET",
"timestamp": "2018-01-07T07:30:58.622Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:aws:ec2:group",
"items": [{"id": "sig-1234567",
"name": "EG",
"description": "validation",
"capacity": {"minimum": 1,
"maximum": 1,
"target": 1,
"unit": "instance"
},
"strategy": {"risk": 100,
"onDemandCount": null,
"availabilityVsCost": "balanced",
"lifetimePeriod": "days",
"fallbackToOd": true,
"persistence": { },
"revertToSpot": {"performAt": "always"
}
},
"compute": {"instanceTypes": {"ondemand": "c3.4xlarge",
"spot": ["c3.2xlarge",
"c4.2xlarge"
]
},
"availabilityZones": {"name": "eu-west-1b",
"subnetIds": ["eu-west-1b"
]
},
"product": "Linux/UNIX (Amazon VPC)",
"launchSpecification": {"loadBalancerNames": null,
"loadBalancersConfig": {"loadBalancers": null
},
"healthCheckGracePeriod": 300,
"securityGroupIds": ["sg-1234567"
],
"monitoring": false,
"ebsOptimized": false,
"imageId": "ami-1234567",
"iamRole": {"name": null,
"arn": "arn:aws:iam::1234356789:instance-profile/Loader"
},
"keyPair": "PA",
"userData": "sldkfoisnfgodng",
"shutdownScript": null,
"tags": {"tagKey": "Env",
"tagValue": "TEST"
},
"tenancy": "default"
}
},
"scaling": { },
"scheduling": {"tasks": [{"frequency": "hourly",
"taskType": "backup_ami"
},
{"isEnabled": true,
"taskType": "scale",
"cronExpression": "55 19 * * 0-4",
"scaleTargetCapacity": 1,
"scaleMinCapacity": 1,
"scaleMaxCapacity": 1
},
{"groupId": "sig-12345",
"eventType": "Scale",
"createdAt": "2016-01-21T16:51:09.000+0000",
"subEvents": {"type": "scaleUp",
"terminatedSpots": [{"spotInstanceRequestId": "sir-029404xk"
},
{"instanceId": "i-7fb4facc"
}
],
"terminatedInstances": ["string"
]
}
}
]
},
"thirdPartiesIntegration": { },
"multai": null,
"createdAt": "2015-10-23T09:00:00.000Z",
"updatedAt": "2018-08-01T14:11:39.000Z"
}
],
"count": 1
}
}

List Stateful Instances

List all stateful instances associated with the Elastigroup

Authorizations:

path Parameters

groupId

required

string

AWS Elastigroup ID

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "ssi-046b119c",
"instanceId": "i-08878aad7f35d20f5",
"privateIp": "172.31.30.122",
"imageId": "ami-082b5a644766e0e6f",
"state": "ACTIVE",
"devices": [{"deviceName": "/dev/xvda",
"volumeId": "vol-0bb1c83fb203ad686",
"snapshotId": "snap-0a2803e5e45d63c3a"
}
],
"launchedAt": "2019-12-10T08:01:43.000Z",
"createdAt": "2019-12-10T08:02:16.000Z"
}
],
"count": 1,
"kind": "string"
}
}

Pause Stateful Instance

Pause a stateful instance

Authorizations:

path Parameters

groupId required	string AWS Elastigroup ID
statefulInstanceId required	string Example: ssi-227a0005 Stateful instance ID

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Resume Stateful Instance

Resume a stateful instance

Authorizations:

path Parameters

groupId required	string AWS Elastigroup ID
statefulInstanceId required	string Example: ssi-227a0005 Stateful instance ID

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Recycle Stateful Instance

Recycle a stateful instance AWS

Authorizations:

path Parameters

groupId required	string AWS Elastigroup ID
statefulInstanceId required	string Example: ssi-227a0005 Stateful instance ID

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

De-allocate Stateful Instance

De-allocate a stateful instance – delete all the resources associated with the instance (network interface, snapshots, volumes)

Authorizations:

path Parameters

groupId required	string AWS Elastigroup ID
statefulInstanceId required	string Example: ssi-227a0005 Stateful instance ID

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Delete Volume in a Stateful Instance

Delete a Volume that is part of a paused stateful instance

Authorizations:

path Parameters

groupId required	string AWS Elastigroup ID
statefulInstanceId required	string Example: ssi-227a0005 Stateful instance ID
volumeId required	string Example: vol-0faa4b2957a3d59c8 Volume ID

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "3b750eff-3940-46b3-a309-aa2b415272fd",
"url": "/aws/ec2/group/sig-98765/statefulInstance/ssi-0d29fe12/volume/vol-0faa4b2957a3d59c8",
"method": "DELETE",
"timestamp": "2021-11-03T11:02:55.608Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Import Stateful Instance

Create a new Stateful Elastigroup – this Elastigroup will have the same configuration and state of the imported instance.

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

required

object

	Array of objects[ items ] An Array holding an object of availabilityZones, this configures the availability zones the group may launch instances in. If this is not passed, the availability zone configuration is taken from the imported instance. Note: This field must be null if statefulMigrationGroup.shouldKeepPrivateIp is true, and must have a minimum of one availability zone.
name required	string Specify the new Elastigroup name.
originalInstanceId required	string The originating Instance ID. This instance will be imported along with its State.
product	string Operation system type. Possible values: Linux/UNIX \| SUSE \| Linux Windows \| Linux/UNIX (Amazon VPC) \| SUSE Linux (Amazon VPC) \| Windows (Amazon VPC).
region	string Specify the AWS Region the instance is running in and the new Elastigroup will be created in.
shouldKeepPrivateIp required	boolean Setting this value to true will maintain the initial instance private IP. This will also require that the original instance be terminated in the import process incurring maintenance time. Note: This value must be false if you would like to configure availability zones and subnet ids.
shouldTerminateInstance	boolean Decide if the instance termination should be automatic or manual. True = automatic termination. False = manual termination.
spotInstanceTypes	Array of strings An Array holding the types of instances to be used in the Elastigroup.

Responses

Request samples

Payload

Content type

application/json

{"statefulMigrationGroup": {"originalInstanceId": "i-123c53d9f152a1234",
"shouldKeepPrivateIp": "false",
"shouldTerminateInstance": true,
"name": "MyNewElastigroup",
"product": "Linux/UNIX (Amazon VPC)",
"spotInstanceTypes": ["m3.large"
],
"region": "us-west-2",
"availabilityZones": [{"name": "us-west-2b",
"subnetIds": ["subnet-12345678"
]
}
]
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "smg-7f041234",
"groupId": "sig-1ed12345",
"state": "MIGRATE_START",
"data": {"originalInstanceId": "i-0a9c53d9f15212345",
"shouldKeepPrivateIp": false,
"shouldTerminateInstance": true
}
}
],
"count": 1,
"kind": "spotinst:aws:ec2:statefulMigrationGroup"
}
}

Get Stateful Import Status

Get the current status of the import process. Possible values are:

MIGRATE_PREPARE_AWS_INSTANCE
MIGRATE_CREATE_IMAGE
MIGRATE_AWAIT_FOR_IMAGE
MIGRATE_AWAIT_USER_ACTION
MIGRATE_TERMINATE_INSTANCE
MIGRATE_AWAIT_INSTANCE_TERMINATION
MIGRATE_UPDATE_GROUP
MIGRATE_LAUNCH_INSTANCE
MIGRATE_AWAIT_INSTANCE_RUNNING
MIGRATE_RESUME_STATEFUL_INSTANCE
MIGRATE_AWAIT_STATEFUL_INSTANCE_RUNNING
MIGRATE_CANCEL
MIGRATE_FINISH
MIGRATE_ERROR

Authorizations:

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
statefulMigrationGroupID required	string Example: statefulMigrationGroupID=smg-7f041234 The Process ID you want to query

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"statefulMigrationId": "string",
"groupId": "string",
"instanceId": "string",
"state": "string",
"stateDescription": "string"
}
],
"count": 1,
"kind": "string"
}
}

Delete Stateful Import Status

Cancel the ongoing stateful import

Authorizations:

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
statefulMigrationGroupID required	string Example: statefulMigrationGroupID=smg-7f041234 The Process ID you want to delete

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "string",
"groupId": "string",
"state": "string"
}
],
"count": 1,
"kind": "string"
}
}

Terminate Stateful Instance During Import Process

Manually terminate the source stateful instance during an stateful instance import.

Authorizations:

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
statefulMigrationGroupID required	string The Process ID you want to terminate

Request Body schema: application/json

object

type	string Valid values: "terminate"

Responses

Request samples

Payload

Content type

application/json

{"userAction": {"type": "terminate"
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "smg-63d3c336",
"groupId": "sig-de019081",
"state": "MIGRATE_TERMINATE_INSTANCE"
}
],
"count": 1,
"kind": "string"
}
}

Instance Lock

Set termination protection for specific instance

Authorizations:

path Parameters

instanceId

required

string

Example: i-123456

AWS Instance ID

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
ttlInMinutes	integer Example: ttlInMinutes=23 Specify a TTL (in minutes) for this lock, meaning, for how long the protection will be valid for.

Responses

Response samples

Content type

application/json

{"request": {"id": "ff3e1e5b-91b8-42fa-8267-b988efc7f662",
"url": "/aws/ec2/instance/i-123456/lock",
"method": "POST",
"timestamp": "2015-06-29T13:01:55.060Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Instance Unlock

Remove the termination protection from specific instance

Authorizations:

path Parameters

instanceId

required

string

Example: i-123456

AWS Instance ID

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "ff3e1e5b-91b8-42fa-8267-b988efc7f662",
"url": "/aws/ec2/instance/i-123456/unlock",
"method": "POST",
"timestamp": "2015-06-29T13:01:55.060Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Get Elastigroup Status

Describes the current status of a specific Elastigroup – entailing information regarding running instance and their status

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

The Spot Elastigroup ID you want to update

query Parameters

accountId

string

Example: accountId=act-123456789

ID of the account associated with your token

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/aws/ec2/group/sig-12345678/status",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:aws:ec2:group",
"items": [{"spotInstanceRequestId": "sir-3thgagpn",
"instanceId": "i-0cc289f12538e4758",
"instanceType": "t2.micro",
"product": "Linux/UNIX",
"groupId": "sig-12345678",
"availabilityZone": "us-west-2a",
"privateIp": "172.31.28.210",
"createdAt": "2018-06-25T11:49:00.000Z",
"publicIp": "10.10.10.10",
"status": "fulfilled",
"lockStatus": "locked",
"protectedUntil": "2021-12-29T11:23:02.714Z"
}
],
"count": 2
}
}

Activity Events

Get historical data on events that happened in a specific Elastigroup like update, scaling activities, creation of new instances, etc.

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

The Spot Elastigroup ID you want to update

query Parameters

accountId	string Example: accountId=act-123456789 ID of the account associated with your token
fromDate required	string Example: fromDate=2016-10-01 Starting date to fetch the events from

Responses

Response samples

Content type

application/json

{"request": {"id": "46642c7d-bc29-417d-8ce4-79626f00c63c",
"url": "/aws/ec2/group/sig-12345/events?fromDate=2016-10-01",
"method": "GET",
"timestamp": "2016-01-21T17:12:51.451Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:aws:ec2:group",
"items": [[{"groupId": "sig-12345",
"eventType": "Update",
"createdAt": "2016-01-21T17:10:04.000+0000",
"subEvents": {"type": "scaleUp",
"newSpots": [{"spotInstanceRequestId": "sir-0294dbzt"
},
{"spotInstanceRequestId": "sir-02940b7h"
},
{"spotInstanceRequestId": "sir-028z1age"
},
{"spotInstanceRequestId": "sir-028z456e"
},
{"spotInstanceRequestId": "sir-028wg6gr"
},
{"spotInstanceRequestId": "sir-0294a9v5"
}
],
"newInstances": ["string"
]
}
},
{"groupId": "sig-12345",
"eventType": "Update",
"createdAt": "2016-01-21T17:10:04.000+0000",
"subEvents": {"type": "scaleUp",
"newSpots": [{"spotInstanceRequestId": "sir-0294dbzt"
},
{"spotInstanceRequestId": "sir-02940b7h"
},
{"spotInstanceRequestId": "sir-028z1age"
},
{"spotInstanceRequestId": "sir-028z456e"
},
{"spotInstanceRequestId": "sir-028wg6gr"
},
{"spotInstanceRequestId": "sir-0294a9v5"
}
],
"newInstances": ["string"
]
}
},
{"groupId": "sig-12345",
"eventType": "Update",
"createdAt": "2016-01-21T17:10:04.000+0000",
"subEvents": {"type": "scaleUp",
"newSpots": [{"spotInstanceRequestId": "sir-0294dbzt"
},
{"spotInstanceRequestId": "sir-02940b7h"
},
{"spotInstanceRequestId": "sir-028z1age"
},
{"spotInstanceRequestId": "sir-028z456e"
},
{"spotInstanceRequestId": "sir-028wg6gr"
},
{"spotInstanceRequestId": "sir-0294a9v5"
}
],
"newInstances": ["string"
]
}
},
{"groupId": "sig-12345",
"eventType": "Update",
"createdAt": "2016-01-21T17:10:04.000+0000",
"subEvents": {"type": "scaleUp",
"newSpots": [{"spotInstanceRequestId": "sir-0294dbzt"
},
{"spotInstanceRequestId": "sir-02940b7h"
},
{"spotInstanceRequestId": "sir-028z1age"
},
{"spotInstanceRequestId": "sir-028z456e"
},
{"spotInstanceRequestId": "sir-028wg6gr"
},
{"spotInstanceRequestId": "sir-0294a9v5"
}
],
"newInstances": ["string"
]
}
}
]
],
"count": 1
}
}

Get Elastilog

You can fetch a group's (Elastigroup/Ocean/Managed Instance) elastilog via the Spot API, in order to be able to consume elastilog from various tools used for log storing and analyzing. Logs have retention of 3 months back, so minimal fromDate should be up to 3 months back at runtime.

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

The Spot Elastigroup ID you want to update

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
fromDate required	string Example: fromDate=1540036800000 Epoch number that represents the date from which to collect the log (millisecond format)
limit	string Example: limit=i-12345678 Maximum number of lines to extract in a response. Max value allowed - 1000. Default: 500
resourceId	string Example: resourceId=i-12345678 Filter extracted log entries for a specific resource id. Default: Null
severity	string Example: severity=ALL Severity of log entries to extract. Valid Values: ALL, INFO,DEBUG,WARN. Default: ALL
toDate required	string Example: toDate=1542715200000 Epoch number that represents the date until which log is collected (millisecond format)

Responses

Response samples

Content type

application/json

{"request": {"id": "46642c7d-bc29-417d-8ce4-79626f00c63c",
"url": "/aws/ec2/group/sig-123456/logs",
"method": "GET",
"timestamp": "2018-11-19T13:49:11.911Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:aws:ec2:group:log",
"items": [[{"message": "ECS Max Capacity. ECS Autoscaler - Cannot scale up since group has reached maximum capacity",
"severity": "WARN",
"createdAt": "2018-11-19T14:38:34.000Z"
},
{"message": "Group sig-e0a2bd7c successfully created.",
"severity": "INFO",
"createdAt": "2018-11-19T14:34:15.000Z"
}
]
],
"count": 2
}
}

Update Capacity

Update the capacity of an Elastigroup

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

The Spot Elastigroup ID you want to update

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

object (Capacity)

maximum	integer Default: 0 Number that indicates minimum instance amount
minimum	integer Default: 0 Number that indicates minimum instance amount
target	integer Default: 0 Number that indicates amount of desired instances

Responses

Request samples

Payload

Content type

application/json

{"capacity": {"minimum": 1,
"maximum": 10,
"target": 2
}
}

Response samples

Content type

application/json

{"request": {"id": "3ab3fdf7-3af3-46db-9e63-b88cfdac058c",
"url": "/aws/ec2/group/sig-b255ac/capacity?accountId=act-567c21",
"method": "PUT",
"timestamp": "2018-08-20T15:31:12.730Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:aws:ec2:group:capacity",
"items": [{"capacity": {"minimum": 1,
"maximum": 10,
"target": 2
}
}
],
"count": 1
}
}

Scale Up

Add instances to your Elastigroup

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

The Spot Elastigroup ID you want to update

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
adjustment	integer Example: adjustment=1 The number of instances to add to the Elastigroup

Responses

Response samples

Content type

application/json

{"request": {"id": "b57207d0-3ab1-4170-8122-a3db9ac92093",
"url": "/aws/ec2/group/sig-abcd1234/scale/up?adjustment=2",
"method": "PUT",
"timestamp": "2017-10-04T08:56:38.071Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:aws:ec2:scale",
"items": [{"newSpotRequests": [{"spotInstanceRequestId": "sir-45sr8c7n",
"instanceId": "i-12345abcde12345",
"availabilityZone": "us-west-2a",
"instanceType": "m3.medium"
},
{"spotInstanceRequestId": "sir-pzb8a2an",
"instanceId": "i-abcde12345abcde",
"availabilityZone": "us-west-2a",
"instanceType": "m3.medium"
}
],
"newInstances": null
}
],
"count": 1
}
}

Scale Down

Remove instances from your Elastigroup. Note - Scale Advanced expression Remove instances from your Elastigroup

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

The Spot Elastigroup ID you want to update

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
adjustment	integer Example: adjustment=1 The number of instances to add to the Elastigroup

Responses

Response samples

Content type

application/json

{"request": {"id": "ff3e1e5b-91b8-42fa-8267-b988efc7f662",
"url": "/aws/ec2/group/sig-12345/scale/down?adjustment=1",
"method": "PUT",
"time": "2015-06-29T13:01:55.060Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:aws:ec2:scale",
"items": [{"victimSpotRequests": [{"spotInstanceRequestId": "sir-02447qg2",
"instanceId": "i-933esr1"
}
],
"victimInstances": [{"instanceId": "i-02447t22"
}
]
}
],
"count": 1
}
}

Suspend Scaling Policies

Suspend processes inside your Elastigroup

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

The Spot Elastigroup ID you want to update

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
policyName required	string Example: policyName=Example Policy Name Policy Name of scaling policy to suspend

Request Body schema: application/json

object (Suspension)

ttlInMinutes

integer

Set TTL in minutes. min value: 1 (one minute). max value: 10080 (one week)

Responses

Request samples

Payload

Content type

application/json

{"suspension": {"ttlInMinutes": 10
}
}

Response samples

Content type

application/json

{"request": {"id": "0bb5db74-2457-4a34-b8f3-174e6bf5578e",
"url": "/aws/ec2/group/sig-12345/scale/suspendPolicy?accountId=act-1234567&policyName=myscalingpolicyname",
"method": "POST",
"timestamp": "2016-06-19T08:41:57.516Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:aws:ec2:suspension",
"items": [{"groupId": "sig-12345",
"policyName": "myscalingpolicyname",
"state": "suspended",
"expiresAt": "2016-06-19T08:51:00:00Z"
}
],
"count": 1
}
}

Suspend Processes

Suspend processes inside your Elastigroup

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

The Spot Elastigroup ID you want to update

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

One of

processes

Array of strings

The names of the processes that will be suspended. Valid values are: AUTO_SCALE, AUTO_HEALING, OUT_OF_STRATEGY, PREVENTIVE_REPLACEMENT, REVERT_PREFERRED, SCHEDULING

Responses

Request samples

Payload

Content type

application/json

Example

{"processes": [["AUTO_SCALE",
"OUT_OF_STRATEGY",
"PREVENTIVE_REPLACEMENT"
]
]
}

Response samples

Content type

application/json

{"request": {"id": "0bb5db74-2457-4a34-b8f3-174e6bf5578e",
"url": "/aws/ec2/group/sig-12345/suspension",
"method": "POST",
"timestamp": "2016-06-19T08:41:57.516Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:aws:ec2:suspension",
"items": [{"groupId": "sig-12345",
"processes": [["AUTO_SCALE"
]
],
"suspensions": [[{"name": "AUTO_SCALE",
"expiresAt": null
},
{"name": "OUT_OF_STRATEGY",
"expiresAt": "2018-10-03T07:23:24.000+0000"
},
{"name": "PREVENTIVE_REPLACEMENT",
"expiresAt": "2018-10-03T09:03:24.000+0000"
},
{"name": "REVERT_PREFERRED",
"expiresAt": null
},
{"name": "SCHEDULING",
"expiresAt": null
}
]
]
}
],
"count": 4
}
}

List Suspended Processes

List all active Suspended processes for specific Elastigroup

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

The Spot Elastigroup ID you want to update

query Parameters

accountId

string

Example: accountId=act-123456789

ID of the account associated with your token

Responses

Response samples

Content type

application/json

{"request": {"id": "67582d0c-108b-4ef7-9fdc-d39678a30844",
"url": "/aws/ec2/group/sig-12345/suspension",
"method": "GET",
"timestamp": "2018-01-07T07:30:58.622Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:aws:ec2:suspension",
"items": [{"groupId": "sig-12345",
"processes": ["AUTO_SCALE"
]
}
],
"count": 1
}
}

Remove Suspended Processes

Remove active suspension from Elastigroup

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

The Spot Elastigroup ID you want to update

query Parameters

accountId

string

Example: accountId=act-123456789

ID of the account associated with your token

Request Body schema: application/json

processes

Array of strings (Processes)

The list of processes to remove from suspension. Valid values are: AUTO_SCALE, AUTO_HEALING, OUT_OF_STRATEGY, PREVENTIVE_REPLACEMENT, REVERT_PREFERRED, SCHEDULING

Responses

Request samples

Payload

Content type

application/json

{"processes": [["AUTO_SCALE"
]
]
}

Response samples

Content type

application/json

{"request": {"id": "848f3db7-b731-4b1b-9227-253a545e90eb",
"url": "/aws/ec2/group/sig-12345/suspension",
"method": "DELETE",
"timestamp": "2018-06-21T11:54:12.513Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:aws:ec2:suspension",
"items": [{"group": {"compute": {"launchSpecification": {"metadataOptions": {"httpTokens": "optional"
}
}
}
}
}
],
"count": 0
}
}

List Suspended Scaling Policies

Suspended scaling policies inside your Elastigroup

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

The Spot Elastigroup ID you want to update

query Parameters

accountId

string

Example: accountId=act-123456789

ID of the account associated with your token

Responses

Response samples

Content type

application/json

{"request": {"id": "0bb5db74-2457-4a34-b8f3-174e6bf5578e",
"url": "/aws/ec2/group/sig-12345/scale/suspensions?accountId=act-1234567",
"method": "GET",
"timestamp": "2016-06-19T08:41:57.516Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:aws:ec2:suspension",
"items": [{"scalePolicySuspensions": [{"groupId": "sig-12345",
"policyName": "test",
"state": "suspended"
},
{"groupId": "sig-12345",
"policyName": "down Scaling Policy 1",
"state": "suspended"
}
]
}
],
"count": 2
}
}

Remove Suspended Scaling Policies

Resume suspended scaling policies inside your Elastigroup

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

The Spot Elastigroup ID you want to update

query Parameters

accountId	string Example: accountId=act-123456789 ID of the account associated with your token
policyName	string Example: policyName=policy_1 Name of the suspended scaling policy to remove from suspension

Responses

Response samples

Content type

application/json

{"request": {"id": "848f3db7-b731-4b1b-9227-253a545e90eb",
"url": "/aws/ec2/group/sig-12345/scale/resumePolicy?policyName=myscalingpolicyname",
"method": "POST",
"timestamp": "2018-06-21T11:54:12.513Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:aws:ec2:suspension",
"items": [{ }
],
"count": 0
}
}

Get Costs per Elastigroup

Get financial information on a specific Elastigroup

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

The Spot Elastigroup ID you want to update

query Parameters

accountId	string Example: accountId=act-123abc ID of the account associated with your token
aggregationPeriod	string Example: aggregationPeriod=daily Optional. The time period over which data is aggregated. Can only be "daily". For example, the figures in each data set are per day
fromDate required	string Example: fromDate=2018-06-20 Data values following either a date format (YYYY-MM-DDTHH:mm:ss.SSSZ ; 2016-01-10T00:00:00.000Z) or Unix seconds Timestamp (1494751821)
toDate required	string Example: toDate=2018-11-20 Data values following either a date format (YYYY-MM-DDTHH:mm:ss.SSSZ ; 2016-01-10T00:00:00.000Z) or Unix seconds Timestamp (1494751821)

Responses

Response samples

Content type

application/json

{"request": {"id": "46642c7d-bc29-417d-8ce4-79626f00c63c",
"url": "/aws/ec2/group/sig-48d79900/costs?fromDate=2018-03-06&toDate=2019-02-27",
"method": "GET",
"timestamp": "2016-01-21T17:12:51.451Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:aws:ec2:group:stats",
"items": [[{"running": {"value": 0,
"unit": "hours"
},
"savings": {"value": 0,
"unit": "percentage"
},
"costs": {"actual": 0,
"potential": 0
}
}
]
],
"count": 1
}
}

Detailed Cost

Get detailed financial information on a specific Elastigroup

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

The Spot Elastigroup ID you want to update

query Parameters

accountId	string Example: accountId=act-123abc ID of the account associated with your token
fromDate required	string Example: fromDate=2018-06-20 Data values following either a date format (YYYY-MM-DDTHH:mm:ss.SSSZ ; 2016-01-10T00:00:00.000Z) or Unix seconds Timestamp (1494751821)
toDate required	string Example: toDate=2018-11-20 Data values following either a date format (YYYY-MM-DDTHH:mm:ss.SSSZ ; 2016-01-10T00:00:00.000Z) or Unix seconds Timestamp (1494751821)

Responses

Response samples

Content type

application/json

{"request": {"id": "46642c7d-bc29-417d-8ce4-79626f00c63c",
"url": "/aws/ec2/group/sig-12345/costs/detailed",
"method": "GET",
"timestamp": "2016-01-21T17:12:51.451Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:aws:ec2:group",
"items": [{"groupId": "sig-12345",
"instanceId": "i-326129e1",
"spotInstanceRequestId": null,
"instanceType": "m3.medium",
"availabilityZone": "us-east-1a",
"running": {"value": 4,
"unit": "hours"
},
"savings": {"value": 4,
"unit": "percentage"
},
"costs": {"actual": 0.268,
"potential": 0.268
}
},
{"groupId": "sig-d56b9e37v",
"instanceId": "i-326129e1",
"spotInstanceRequestId": "sir-02epa938",
"instanceType": "m3.large",
"availabilityZone": "us-east-1a",
"running": {"value": 4,
"unit": "hours"
},
"savings": {"value": 89.3233,
"unit": "percentage"
},
"costs": {"actual": 0.0568,
"potential": 0.532
}
}
],
"count": 2
}
}

Instance Status

Get the current instance status Possible status values - Active and Terminating

Authorizations:

path Parameters

instanceId

required

string

Example: i-123456

The instance ID you want to query

query Parameters

accountId

string

Example: accountId=act-123abc

ID of the account associated with your token

Responses

Response samples

Content type

application/json

{"request": {"id": "ff3e1e5b-91b8-42fa-8267-b988efc7f662",
"url": "/aws/ec2/instance/i-123456",
"method": "GET",
"timestamp": "2015-06-29T13:01:55.060Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:aws:ec2:instance",
"items": [{"instanceId": "i-326129e1",
"lifeCycleState": "ACTIVE"
}
],
"count": 1
}
}

Import EC2 Instance

Import an EC2 instance into a new Elastigroup

Authorizations:

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
instanceId required	string Example: instanceId=i-008a13360040aa88e Enter the AWS instance Id of the instance to import
region required	string Example: region=us-east-2 The AWS region to create the new Elastigroup in

Request Body schema: application/json

object (Group)

name	string The name of the new Elastigroup
spotInstanceTypes	array Optionally provide a list of spot instance types to improve spot market availability for the Elastigroup. Overrides the imported instance type.

Responses

Request samples

Payload

Content type

application/json

{"group": {"name": "EG_Name",
"spotInstanceTypes": ["m3.large",
"c3.large"
]
}
}

Response samples

Content type

application/json

{"request": {"id": "ff3e1e5b-91b8-42fa-8267-b988efc7f662",
"url": "string",
"method": "GET",
"timestamp": "2015-06-29T13:01:55.060Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "string",
"items": [{ }
],
"count": 1
}
}

AMI Backup

Get status of a specific deployment

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

The Spot Elastigroup ID you want to update

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "46642c7d-bc29-417d-8ce4-79626f00c63c",
"url": "/aws/ec2/group/sig-61236h9d/amiBackup",
"method": "POST",
"timestamp": "2016-01-21T17:12:51.451Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:aws:ec2:group:amiBackup",
"items": true
}
}

Instance Healthiness

Get a list of instances with health status. In case a shutdown script is configured for the group, it will also retrieve the Spot Agent health status.

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

The Spot Elastigroup ID you want to update

query Parameters

accountId

string

Example: accountId=act-123abc

ID of the account associated with your token

Responses

Response samples

Content type

application/json

{"request": {"id": "ff3e1e5b-91b8-42fa-8267-b988efc7f662",
"url": "/aws/ec2/group/sig-1b656b92/instanceHealthiness",
"method": "GET",
"timestamp": "2015-06-29T13:01:55.060Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:aws:ec2:group:instanceHealthiness",
"items": [{"instanceId": "i-07593cd9173cd9667",
"spotRequestId": "sir-xjag9yqp",
"groupId": "sig-1b656b92",
"availabilityZone": "us-west-2b",
"lifeCycle": "SPOT",
"healthStatus": "HEALTHY",
"agentHealth": {"status": "HEALTHY",
"lastChecked": "2021-12-15T14:43:46.000Z"
}
}
],
"count": 1
}
}

Detach Instance

Detach instances from your Elastigroup

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

The Spot Elastigroup ID you want to update

query Parameters

accountId

string

Example: accountId=act-123abc

ID of the account associated with your token

Request Body schema: application/json

drainingTimeout	integer (Time) Draining Timeout
instancesToDetach	object (Instances to be detached) Instances to be detached
shouldDecrementTargetCapacity	boolean (Decrement target capacity criteria) Should Decrement Target Capacity Criteria
shouldTerminateInstances	boolean (Termination criteria) Should Terminate Instances Criteria

Responses

Request samples

Payload

Content type

application/json

{"instancesToDetach": ["i-123456",
"i-456798"
],
"shouldTerminateInstances": true,
"shouldDecrementTargetCapacity": false,
"drainingTimeout": 300
}

Response samples

Content type

application/json

{"request": {"id": "0bb5db74-2457-4a34-b8f3-174e6bf5578e",
"url": "/aws/ec2/group/sig-12345/detachInstances",
"method": "PUT",
"timestamp": "2016-06-19T08:41:57.516Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:aws:ec2:detachInstances"
}
}

Import ASG

Create a new Elastigroup – this Elastigroup will have the same configuration of the imported Autoscaling group

Authorizations:

query Parameters

accountId	string Example: accountId=act-12345 Your account ID in Spot
autoScalingGroupName required	string Example: autoScalingGroupName=MyASG The ASG name
dryRun	boolean Example: dryRun=true When `dryRun` is set to `true`, the API call will return the Elastigroup configuration without actually performing any action
region required	string Example: region=us-east-1 The AWS region for the ASG

Request Body schema: application/json

object (Group)

availabilityVsCost	string Default: "balanced" Enum: "costOriented" "availabilityOriented" "balanced" "cheapest" "equalAzDistribution" How Elastigroup determines which instances to add and replace. (please read this article before using Equal AZ Instance Distribution)
name	string (Name) The name of the Elastigroup to be created
product	string (Product (OS)) Operation system type. Possible values: Linux/UNIX \| SUSE \| Linux Windows \| Linux/UNIX (Amazon VPC) \| SUSE Linux (Amazon VPC) \| Windows (Amazon VPC)
spotInstanceTypes	array (Product (OS)) An Array holding the types of instances to be used in the Elastigroup

Responses

Request samples

Payload

Content type

application/json

{"group": {"product": "Linux/UNIX",
"spotInstanceTypes": ["c3.large",
"m4.large"
],
"name": "My Group",
"availabilityVsCost": "costOriented"
}
}

Response samples

Content type

application/json

{"request": {"id": "ff3e1e5b-91b8-42fa-8267-b988efc7f662",
"url": "/aws/ec2/group/autoScalingGroup/import?region=us-west-2&TESTING_ASG",
"method": "POST",
"timestamp": "2015-06-29T13:01:55.060Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:aws:ec2:group",
"items": [{"id": "sig-e2927aac",
"name": "TESTING_ASG",
"description": "Imported from auto scaling group TESTING_ASG",
"capacity": {"target": 1,
"minimum": 0,
"maximum": 5,
"unit": "instance"
},
"strategy": {"risk": 100,
"drainingTimeout": 0
},
"compute": {"instanceTypes": {"ondemand": "m3.medium",
"spot": ["c3.large"
]
},
"availabilityZones": [{"name": "us-west-2b",
"subnetIds": "subnet-2e967065"
}
],
"product": "Linux/UNIX",
"launchSpecification": {"loadBalancersConfig": {"loadBalancers": {"name": "TESTING_ASG",
"type": "CLASSIC"
}
}
}
},
"scaling": { },
"createdAt": "2020-10-01T05:23:59.302Z",
"updatedAt": "2020-10-01T05:23:59.302Z"
}
],
"count": 1
}
}

Instance Type By Region

Get the available spot instances types available in a specific region

Authorizations:

query Parameters

region

required

string

Example: region=us-east-2

The AWS region

Responses

Response samples

Content type

application/json

{"request": {"id": "67582d0c-108b-4ef7-9fdc-d39678a30844",
"url": "/aws/ec2/spotType?region=us-west-2",
"method": "GET",
"timestamp": "2018-01-07T07:30:58.622Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:aws:ec2:spot:type",
"items": [[{"instanceType": "hi1.4xlarge"
},
{"instanceType": "r5d.4xlarge"
},
{"instanceType": "r5ad.12xlarge"
},
{"instanceType": "r4.4xlarge"
},
{"instanceType": "m1.xlarge"
},
{"instanceType": "a1.4xlarge"
},
{"instanceType": "m5a.4xlarge"
},
{"instanceType": "m3.large"
},
{"instanceType": "x1e.4xlarge"
},
{"instanceType": "m5d.4xlarge"
},
{"instanceType": "m5a.24xlarge"
},
{"instanceType": "m5a.large"
},
{"instanceType": "r5d.8xlarge"
},
{"instanceType": "m3.medium"
},
{"instanceType": "p2.xlarge"
},
{"instanceType": "m4.large"
},
{"instanceType": "m5.24xlarge"
},
{"instanceType": "r5a.4xlarge"
},
{"instanceType": "c5.large"
},
{"instanceType": "m5ad.xlarge"
},
{"instanceType": "m5d.large"
},
{"instanceType": "r5d.12xlarge"
},
{"instanceType": "r5a.2xlarge"
},
{"instanceType": "m3.2xlarge"
},
{"instanceType": "t3a.large"
},
{"instanceType": "t2.medium"
},
{"instanceType": "i3.2xlarge"
},
{"instanceType": "p3.2xlarge"
},
{"instanceType": "cc2.8xlarge"
},
{"instanceType": "i3.xlarge"
},
{"instanceType": "r3.2xlarge"
},
{"instanceType": "i3.8xlarge"
},
{"instanceType": "c4.8xlarge"
},
{"instanceType": "r5.metal"
},
{"instanceType": "m4.10xlarge"
},
{"instanceType": "m1.large"
},
{"instanceType": "r5d.2xlarge"
},
{"instanceType": "t1.micro"
},
{"instanceType": "i2.4xlarge"
},
{"instanceType": "r5a.24xlarge"
},
{"instanceType": "z1d.2xlarge"
},
{"instanceType": "r5.xlarge"
},
{"instanceType": "m5ad.large"
},
{"instanceType": "h1.4xlarge"
},
{"instanceType": "m5d.12xlarge"
},
{"instanceType": "c5.2xlarge"
},
{"instanceType": "x1e.8xlarge"
},
{"instanceType": "d2.8xlarge"
},
{"instanceType": "r5.8xlarge"
},
{"instanceType": "c3.large"
},
{"instanceType": "r4.xlarge"
},
{"instanceType": "m5ad.24xlarge"
},
{"instanceType": "t3a.xlarge"
},
{"instanceType": "d2.4xlarge"
},
{"instanceType": "c5.24xlarge"
},
{"instanceType": "c5.metal"
},
{"instanceType": "c1.medium"
},
{"instanceType": "m1.medium"
},
{"instanceType": "g3.8xlarge"
},
{"instanceType": "r4.2xlarge"
},
{"instanceType": "i3en.6xlarge"
},
{"instanceType": "t3.small"
},
{"instanceType": "i3en.large"
},
{"instanceType": "i3en.24xlarge"
},
{"instanceType": "t2.xlarge"
},
{"instanceType": "t3a.medium"
},
{"instanceType": "m4.16xlarge"
},
{"instanceType": "x1.32xlarge"
},
{"instanceType": "r5a.12xlarge"
},
{"instanceType": "c5d.4xlarge"
},
{"instanceType": "i3en.12xlarge"
},
{"instanceType": "c5d.large"
},
{"instanceType": "g3.16xlarge"
},
{"instanceType": "c3.2xlarge"
},
{"instanceType": "x1e.2xlarge"
},
{"instanceType": "a1.2xlarge"
},
{"instanceType": "r5ad.xlarge"
},
{"instanceType": "m5a.xlarge"
},
{"instanceType": "t2.large"
},
{"instanceType": "r5ad.large"
},
{"instanceType": "i3.metal"
},
{"instanceType": "t3.nano"
},
{"instanceType": "r5ad.2xlarge"
},
{"instanceType": "f1.16xlarge"
},
{"instanceType": "h1.8xlarge"
},
{"instanceType": "m5.12xlarge"
},
{"instanceType": "a1.medium"
},
{"instanceType": "i3en.3xlarge"
},
{"instanceType": "m5d.8xlarge"
}
]
],
"count": 322
}
}

Simulate an Instance Interruption

The simulate instance interruption API is used for simulating a spot interruption in AWS, so that customers can verify specific applicative behaviors in case an interruption takes place. Once the interruption api is called, instances posted in the API body will be terminated in AWS, thus mocking a spot interruption.

Authorizations:

query Parameters

accountId

string

Example: accountId=act-123abc

ID of the account associated with your token

Request Body schema: application/json

instancesToInterrupt

string

A list of group's instance ids to interrupt

Responses

Request samples

Payload

Content type

application/json

{"instancesToInterrupt": ["i-123456",
"i-9876543"
]
}

Response samples

Content type

application/json

{"request": {"id": "ff3e1e5b-91b8-42fa-8267-b988efc7f662",
"url": "/aws/ec2/instance/interruption?accountId=act-4fb595c6",
"method": "POST",
"timestamp": "2015-06-29T13:01:55.060Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Create Instance Signal

The instance signal API is used for notifying Spot about the instance state, so Spot can act accordingly. Supported signals are - INSTANCE_READY – Whenever this signal is sent, Spot will register the instance to the ELB INSTANCE_READY_TO_SHUTDOWN – Whenever this signal is sent, Spot will terminate the instance after it was marked for termination. Important - You need to define the expected signals for your Elastigroup in the group configuration.

Authorizations:

query Parameters

accountId

string

Example: accountId=act-123abc

ID of the account associated with your token

Request Body schema: application/json

instanceId	string The instance ID the signal refers to.
signal	string The specific signal you want to trigger. Valid Values - INSTANCE_READY, INSTANCE_READY_TO_SHUTDOWN

Responses

Request samples

Payload

Content type

application/json

{"instanceId": "i-123456",
"signal": "INSTANCE_READY"
}

Response samples

Content type

application/json

{"request": {"id": "67582d0c-108b-4ef7-9fdc-d39678a30844",
"url": "/aws/ec2/instance/signal",
"method": "POST",
"timestamp": "2018-01-07T07:30:58.622Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Instance Standby

Instance Standby enables you to put an instance in Standby state , update or troubleshoot the instance, and then return the instance to service. Instances that are on standby are still part of the Elastigroup, but they don't get application traffic. Whenever instance is standby state - It will be de-registered from all the ELBs / ALBs in the Elastigroup It won't be affected from Scale down activities in the Elastigroup The instance health won't be checked, and it won't be replaced When the instance exits the Standby state - The instance will be register back to all the ELBs / ALBs that are defined in the Elastigroup It will be considered and affected from all the Elastigroup activities (helth checks, scaling, etc.)

Authorizations:

path Parameters

instanceId

required

string

Example: i-123456

The instance ID you want to put in standby state

query Parameters

accountId

string

Example: accountId=act-123abc

ID of the account associated with your token

Responses

Response samples

Content type

application/json

{"request": {"id": "ff3e1e5b-91b8-42fa-8267-b988efc7f662",
"url": "/aws/ec2/instance/i-123456/standby/enter",
"method": "POST",
"timestamp": "2015-06-29T13:01:55.060Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Exit Instance Standby

Exit standby by mode

Authorizations:

path Parameters

instanceId

required

string

Example: i-123456

The instance ID you want to put in standby state

query Parameters

accountId

string

Example: accountId=act-123abc

ID of the account associated with your token

Responses

Response samples

Content type

application/json

{"request": {"id": "ff3e1e5b-91b8-42fa-8267-b988efc7f662",
"url": "/aws/ec2/instance/i-123456/standby/exit",
"method": "POST",
"timestamp": "2015-06-29T13:01:55.060Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Group's Deployments Status

Get list of all the deployments of a specific Elastigroup and their status

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

The Spot Elastigroup ID you want to update

query Parameters

accountId	string Example: accountId=act-123abc ID of the account associated with your token
limit	integer Example: limit=5 Limits results
sort	string Example: sort=createdAt:ASC Field to sort by the results Default: createdAt:DESC

Responses

Response samples

Content type

application/json

{"request": {"id": "46642c7d-bc29-417d-8ce4-79626f00c63c",
"url": "/aws/ec2/group/sig-12345/roll?limit=5&sort=createdAt%3ADESC",
"method": "GET",
"timestamp": "2016-01-21T17:12:51.451Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:aws:ec2:group:roll",
"items": [{"id": "sbgd-781c6212",
"status": "starting",
"progress": {"unit": "percent",
"value": 0
},
"createdAt": "2018-03-27T19:50:12.000+0000",
"updatedAt": "2018-03-27T19:50:16.000+0000"
},
{"id": "sbgd-3f127ed0",
"status": "starting",
"progress": {"unit": "percent",
"value": 0
},
"createdAt": "2018-03-27T19:46:22.000+0000",
"updatedAt": "2018-03-27T19:46:35.000+0000"
},
{"id": "sbgd-3ee19606",
"status": "stopped",
"progress": {"unit": "percent",
"value": 0
},
"createdAt": "2018-03-27T19:35:41.000+0000",
"updatedAt": "2018-03-27T19:39:18.000+0000"
},
{"id": "sbgd-cc4c44e2",
"status": "finished",
"progress": {"unit": "percent",
"value": 100
},
"createdAt": "2018-03-26T19:22:45.000+0000",
"updatedAt": "2018-03-26T19:26:17.000+0000"
}
],
"count": 1
}
}

Start Deployment

Deploy your Elastigroup (triggers Blue/Green Deployment that replaces the existing instances in the Elastigroup)

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

The Spot Elastigroup ID you want to update

query Parameters

accountId

string

Example: accountId=act-123abc

ID of the account associated with your token

Request Body schema: application/json

batchSizePercentage required	integer Indicates (in percentage) the batch size of the deployment (meaning, how many instances to replace in each batch)
drainingTimeout	integer >= 0 Default: 120 Indicates (in seconds) the timeout to drain the instances. Override the group value.
gracePeriod required	integer Indicates (in seconds) the timeout to wait until instance become healthy based on the healthCheckType
healthCheckType	string Enum: "ELB" "ECS_CLUSTER_INSTANCE" "TARGET_GROUP" "OPSWORKS" "NOMAD_NODE" "MULTAI_TARGET_SET" "HCS" "EC2" "NONE" Define a health check type. If no value is set the roll will use the group’s auto-healing health check.
	object The roll strategy

Responses

Request samples

Payload

Content type

application/json

{"batchSizePercentage": 20,
"gracePeriod": 300,
"healthCheckType": "EC2",
"drainingTimeout": 60,
"strategy": {"action": "REPLACE_SERVER",
"batchMinHealthyPercentage": 25,
"onFailure": {"actionType": "DETACH_NEW",
"shouldHandleAllBatches": true,
"drainingTimeout": 120,
"shouldDecrementTargetCapacity": true
}
}
}

Response samples

Content type

application/json

{"request": {"id": "46642c7d-bc29-417d-8ce4-79626f00c63c",
"url": "/aws/ec2/group/sig-12345/roll?accountId=act-123456",
"method": "PUT",
"timestamp": "2016-01-21T17:12:51.451Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:aws:ec2:group:roll",
"items": [{"id": "sbgd-3ee19606",
"status": "STARTING",
"currentBatch": 1,
"numOfBatches": 1,
"progress": {"unit": "percent",
"value": 0
}
}
],
"count": 1
}
}

Stop Deployment

Stop an existing deployment

Authorizations:

path Parameters

groupId required	string Example: sig-12345 The Spot Elastigroup ID you want to update
rollId required	string Example: sbgd-9876 The deployment ID you want to stop

query Parameters

accountId

string

Example: accountId=act-123abc

ID of the account associated with your token

Request Body schema: application/json

object (Role)

status

string (Status)

Set the status of the group to `STOPPED"

Responses

Request samples

Payload

Content type

application/json

{"roll": {"status": "STOPPED"
}
}

Response samples

Content type

application/json

{"request": {"id": "ff3e1e5b-91b8-42fa-8267-b988efc7f662",
"url": "/aws/ec2/group/sig-12345/roll/sbgd-dfb956b4",
"method": "PUT",
"timestamp": "2015-06-29T13:01:55.060Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:aws:ec2:group:roll"
}
}

Deployment Status

Get status of a specific deployment

Authorizations:

path Parameters

groupId required	string Example: sig-12345 The Spot Elastigroup ID you want to update
rollId required	string Example: sbgd-9876 The deployment ID you want to query

query Parameters

accountId

string

Example: accountId=act-123abc

ID of the account associated with your token

Responses

Response samples

Content type

application/json

{"request": {"id": "46642c7d-bc29-417d-8ce4-79626f00c63c",
"url": "/aws/ec2/group/sig-d8489594/deployment/sbgd-3e158755/status?spotinstAccountId=act-d48178ad",
"method": "GET",
"timestamp": "2016-01-21T17:12:51.451Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:aws:ec2:group:roll:status",
"items": [{"progress": {"unit": "percent",
"value": 50
},
"numberOfBatches": 2,
"currentBatch": 1,
"gracePeriod": 600,
"strategyAction": "REPLACE_SERVER",
"healthCheck": "NONE",
"instances": [{"blue": [{"instanceId": "i-0b3f1234567890ae5",
"lifeCycle": "spot",
"batchNum": 1,
"status": "RUNNING"
}
],
"green": [{"instanceId": "i-0b3f1234567890dd5",
"lifeCycle": "spot",
"batchNum": 1,
"status": "RUNNING"
}
]
},
{"blue": [{"instanceId": "i-0b3f1234567890aa6",
"lifeCycle": "spot",
"batchNum": 2,
"status": "DETACHED"
}
],
"green": [{"instanceId": "i-0b3f1234567890dq3",
"lifeCycle": "spot",
"batchNum": 2,
"status": "RUNNING"
}
]
}
]
}
],
"count": 1
}
}

Deployment Actions

Apply a Detach action to a deployment

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

The Spot Elastigroup ID you want to update

query Parameters

accountId	string Example: accountId=act-123abc ID of the account associated with your token
rollId required	string Example: rollId=sbgd-9876 The deployment ID to call the action on

Request Body schema: application/json

actionType	string (Type of action) Sets the action that will take place, Accepted values are: DETACH_OLD, DETACH_NEW
drainingTimeout	integer (Draining timeout criteria) Indicates (in seconds) the timeout to wait until instance are detached
shouldDecrementTargetCapacity	boolean (Should Decrement Target Capacity criteria) Default: true
shouldHandleAllBatches	boolean (Should Hnadle All Batches Criteria) Default: false Indicator if the action should apply to all batches of the deployment or only the latest batch

Responses

Request samples

Payload

Content type

application/json

{"actionType": "DETACH_NEW",
"shouldHandleAllBatches": true,
"drainingTimeout": 200,
"shouldDecrementTargetCapacity": true
}

Response samples

Content type

application/json

{"request": {"id": "46642c7d-bc29-417d-8ce4-79626f00c63c",
"url": "/aws/ec2/group/sig-1b656b92/roll/sbgd-aafb7671/action",
"method": "POST",
"timestamp": "2016-01-21T17:12:51.451Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:aws:ec2:group:roll:action",
"items": [{"groupId": "sig-1b656b92",
"rollId": "sbgd-aafb7671",
"actionType": "DETACH_NEW",
"detachedInstances": ["i-0b6974ad592f8d9ba"
]
}
],
"count": 1
}
}

ECS Initiate Cluster Roll

Initiate a cluster roll for an Elastigroup with ECS cluster

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

Elastigroup ID

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

required

object

batchMinHealthyPercentage	integer Default: 50 Indicates the threshold of minimum healthy instances in single batch. If the amount of healthy instances in single batch is under the threshold, the cluster roll will fail. If exists, the parameter value will be in range of 1-100. In case of null as value, the default value in the backend will be 50%. Value of param should represent the number in percentage (%) of the batch.
batchSizePercentage required	integer Size of patch for roll as a percent
comment	string Add a comment description for the roll. comment should be limit to 256 chars.

Responses

Request samples

Payload

Content type

application/json

{"roll": {"batchSizePercentage": 20,
"comment": "This is why I deployed my cluster.",
"batchMinHealthyPercentage": 100
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "scr-5aaf854e",
"scope": "Cluster",
"status": "IN_PROGRESS",
"currentBatch": 1,
"numOfBatches": 5,
"comment": "This is why I deployed my cluster.",
"batchMinHealthyPercentage": 100,
"progress": {"unit": "percentage",
"value": 0,
"detailedStatus": {"oldInstances": [{"instanceId": "i-003a0281a24c01a20",
"status": "REPLACED"
},
{"instanceId": "i-003a0281a24c01a21",
"status": "TO_BE_REPLACED"
},
{"instanceId": "i-003a0281a24c01a22",
"status": "COULD_NOT_BE_REPLACED"
}
]
}
},
"groupId": "sig-43a8a5ee",
"createdAt": "2019-03-24T15:46:09.000Z",
"updatedAt": "2019-03-24T15:46:09.000Z"
}
],
"count": 1,
"kind": "string"
}
}

ECS Update Cluster Roll Status

Update a running ECS cluster roll status

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

Elastigroup ID

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

required

object

status

required

string

Valid values: "STOPPED"

Responses

Request samples

Payload

Content type

application/json

{"roll": {"status": "STOPPED"
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "scr-5aaf854e",
"scope": "Cluster",
"status": "IN_PROGRESS",
"currentBatch": 1,
"numOfBatches": 5,
"comment": "This is why I deployed my cluster.",
"batchMinHealthyPercentage": 100,
"progress": {"unit": "percentage",
"value": 0,
"detailedStatus": {"oldInstances": [{"instanceId": "i-003a0281a24c01a20",
"status": "REPLACED"
},
{"instanceId": "i-003a0281a24c01a21",
"status": "TO_BE_REPLACED"
},
{"instanceId": "i-003a0281a24c01a22",
"status": "COULD_NOT_BE_REPLACED"
}
]
}
},
"groupId": "sig-43a8a5ee",
"createdAt": "2019-03-24T15:46:09.000Z",
"updatedAt": "2019-03-24T15:46:09.000Z"
}
],
"count": 1,
"kind": "string"
}
}

ECS Get All Cluster Rolls Per Elastigroup

Get status for every ECS cluster rolls in given Elastigroup

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

Elastigroup ID

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "scr-5aaf854e",
"scope": "Cluster",
"status": "IN_PROGRESS",
"currentBatch": 1,
"numOfBatches": 5,
"comment": "This is why I deployed my cluster.",
"batchMinHealthyPercentage": 100,
"progress": {"unit": "percentage",
"value": 0,
"detailedStatus": {"oldInstances": [{"instanceId": "i-003a0281a24c01a20",
"status": "REPLACED"
},
{"instanceId": "i-003a0281a24c01a21",
"status": "TO_BE_REPLACED"
},
{"instanceId": "i-003a0281a24c01a22",
"status": "COULD_NOT_BE_REPLACED"
}
]
}
},
"groupId": "sig-43a8a5ee",
"createdAt": "2019-03-24T15:46:09.000Z",
"updatedAt": "2019-03-24T15:46:09.000Z"
}
],
"count": 1,
"kind": "string"
}
}

ECS Get Cluster Roll Status by Roll ID

Get status for specific ECS cluster rolls in given Elastigroup

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

Elastigroup ID

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
ROLL_ID required	string The cluster roll ID you want to query

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "scr-5aaf854e",
"scope": "Cluster",
"status": "IN_PROGRESS",
"currentBatch": 1,
"numOfBatches": 5,
"comment": "This is why I deployed my cluster.",
"batchMinHealthyPercentage": 100,
"progress": {"unit": "percentage",
"value": 0,
"detailedStatus": {"oldInstances": [{"instanceId": "i-003a0281a24c01a20",
"status": "REPLACED"
},
{"instanceId": "i-003a0281a24c01a21",
"status": "TO_BE_REPLACED"
},
{"instanceId": "i-003a0281a24c01a22",
"status": "COULD_NOT_BE_REPLACED"
}
]
}
},
"groupId": "sig-43a8a5ee",
"createdAt": "2019-03-24T15:46:09.000Z",
"updatedAt": "2019-03-24T15:46:09.000Z"
}
],
"count": 1,
"kind": "string"
}
}

Start Beanstalk Maintenance

Put your Beanstslk Elastigroup into maintenance mode, before you start updating the beanstalk configuration.

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

The Spot Elastigroup ID

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Finish Beanstalk Maintenance

Finish maintenance mode, and trigger a blue-green deployment.

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

Elastigroup ID

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Get Beanstalk Maintenance Status

Get the group maintenance status.

If the status is ACTIVE: putting the group in maintenance mode is allowed.
If the status is AWAIT_USER_UPDATE: the group is pending for manually finishing maintenance mode.
If the status is CANCELING_MAINTENANCE_MODE: the group is in the process of canceling maintenance mode.

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

Elastigroup ID

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"status": "AWAIT_USER_UPDATE"
}
],
"count": 1,
"kind": "spotinst:aws:ec2:beanstalk:status"
}
}

Get Beanstalk Configuration

Get your Beanstalk environment configuration from AWS. This call is typically used as the initial step in importing your existing Beanstalk configuration to an Elastigroup.
Note: To optimize the availability of your Beanstalk workload on Elastigroup, instance types similar to those running in your existing configuration are automatically added to the response under instanceTypes. Should these instance types not meet your requirements you may remove them.

Authorizations:

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
environmentId required	string Example: environmentId=e-12345 The Beanstalk name
region required	string Example: region=us-east-1 The AWS region for the Beanstalk

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"group": {"name": "First Elastigroup",
"description": "This is the first Spot Elastigroup of many",
"capacity": {"minimum": 1,
"maximum": 10,
"target": 5
},
"strategy": {"risk": 100
},
"compute": {"instanceTypes": {"ondemand": "t2.micro",
"spot": ["string"
]
},
"availabilityZones": [{"name": "us-west-2a"
}
],
"launchSpecification": {"loadBalancersConfig": {"loadBalancers": [{"name": "awseb-AWSEB-12345",
"arn": "arn:aws:elasticloadbalancing:us-west-2:842422002533:targetgroup/awseb-AWSEB-12345/245f20215d9ba7fc",
"type": "TARGET_GROUP"
}
]
},
"healthCheckType": "EC2",
"securityGroupIds": ["sg-12345"
],
"monitoring": true,
"imageId": "ami-12345",
"iamRole": {"name": "aws-elasticbeanstalk-ec2-role"
},
"userData": "Q29udGVudC1UeXBlOiBtdWx0aXBhcnQvbWl4ZWQ7IGJvdW5kYXJ5PSI9PT09PT09PT09PT09PT01MTg5MDY1Mzc3MjIyODk4NDA3PT0iCk1JTUUtVmVyc2lvbjogMS4wCgotLT09PT09PT09PT09PT09PTUxODkwNjUzNzcyMjI4OTg0MDc9PQpDb250ZW50LVR5cGU6IHRleHQvY2xvdWQtY29uZmlnOyBjaGFyc2V0PSJ1cy1hc2NpaSIKTUlNRS1WZXJzaW9uOiAxLjAKQ29udGVudC1UcmFuc2Zlci1FbmNvZGluZzogN2JpdApDb250ZW50LURpc3Bvc2l0aW9uOiBhdHRhY2htZW50OyBmaWxlbmFtZT0iY2xvdWQtY29uZmlnLnR4dCIKCiNjbG91ZC1jb25maWcKcmVwb191cGdyYWRlOiBub25lCnJlcG9fcmVsZWFzZXZlcjogMjAxNy4wOQpjbG91ZF9maW5hbF9tb2R1bGVzOgogLSBbc2NyaXB0cy11c2VyLCBhbHdheXNdCgotLT09PT09PT09PT09PT09PTUxODkwNjUzNzcyMjI4OTg0MDc9PQpDb250ZW50LVR5cGU6IHRleHQveC1zaGVsbHNjcmlwdDsgY2hhcnNldD0idXMtYXNjaWkiCk1JTUUtVmVyc2lvbjogMS4wCkNvbnRlbnQtVHJhbnNmZXItRW5jb2Rpbmc6IDdiaXQKQ29udGVudC1EaXNwb3NpdGlvbjogYXR0YWNobWVudDsgZmlsZW5hbWU9InVzZXItZGF0YS50eHQiCgojIS9iaW4vYmFzaApleGVjID4gPih0ZWUgLWEgL3Zhci9sb2cvZWItY2ZuLWluaXQubG9nfGxvZ2dlciAtdCBbZWItY2ZuLWluaXRdIC1zIDI",
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
]
}
},
"scaling": {"up": [{"policyName": "awseb-e-12345-stack-AWSEBCloudwatchAlarmHigh-56QPITB3WUFM",
"metricName": "NetworkOut",
"statistic": "average",
"unit": "bytes",
"threshold": 6000000,
"namespace": "AWS/EC2",
"source": "cloudWatch",
"period": 300,
"evaluationPeriods": 1,
"cooldown": 360,
"dimenstions": [{"name": "resourceName"
}
],
"action": {"type": "adjustment",
"adjustment": 1
},
"operator": "gte"
}
],
"down": [{"policyName": "awseb-e-12345-stack-AWSEBCloudwatchAlarmLow-UNGVBRKT0EHP",
"metricName": "NetworkOut",
"statistic": "average",
"unit": "bytes",
"threshold": 2000000,
"namespace": "AWS/EC2",
"source": "cloudWatch",
"period": 300,
"evaluationPeriods": 1,
"cooldown": 360,
"dimenstions": [{"name": "resourceName"
}
],
"action": {"type": "adjustment",
"adjustment": 1
},
"operator": "lte"
}
]
},
"thirdPartiesIntegration": {"elasticBeanstalk": {"environmentId": "e-12345"
}
}
}
}
],
"count": 1,
"kind": "spotinst:aws:ec2:group"
}
}

Beanstalk Reimport

Re-import the beanstalk configuration

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

Elastigroup ID

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"group": {"id": "sig-123456",
"compute": {"launchSpecification": {"securityGroupIds": ["sg-b75343cf"
],
"monitoring": false,
"imageId": "ami-3c873e5c",
"iamRole": {"name": "aws-elasticbeanstalk-ec2-role"
},
"userData": "Q29udGVudC1UeXBlOiBtdWx0aXBhcnQvbWl4ZWQ7IGJvdW5kYXJ5PSI9PT09PT09PT09PT09PT01MTg5MDY1Mzc3MjIyODk4NDA3PT0iCk1JTUUtVmVyc2lvbjogMS4wCgotLT09PT09PT09PT09PT09PTUxODkwNjUzNzcyMjI4OTg0MDc9PQpDb250ZW50LVR5cGU6IHRleHQvY2xvdWQtY29uZmlnOyBjaGFyc2V0PSJ1cy1hc2NpaSIKTUlNRS1WZXJzaW9uOiAxLjAKQ29udGVudC1UcmFuc2Zlci1FbmNvZGluZzogN2JpdApDb250ZW50LURpc3Bvc2l0aW9uOiBhdHRhY2htZW50OyBmaWxlbmFtZT0iY2xvdWQtY29uZmlnLnR4dCIKCiNjbG91ZC1jb25maWcKcmVwb191cGdyYWRlOiBub25lCnJlcG9fcmVsZWFzZXZlcjogMjAxNy4wOQpjbG91ZF9maW5hbF9tb2R1bGVzOgogLSBbc2NyaXB0cy11c2VyLCBhbHdheXNdCgotLT09PT09PT09PT09PT09PTUxODkwNjUzNzcyMjI4OTg0MDc9PQpDb250ZW50LVR5cGU6IHRleHQveC1zaGVsbHNjcmlwdDsgY2hhcnNldD0idXMtYXNjaWkiCk1JTUUtVmVyc2lvbjogMS4wCkNvbnRlbnQtVHJhbnNmZXItRW5jb2Rpbmc6IDdiaXQKQ29udGVudC1EaXNwb3NpdGlvbjogYXR0YWNobWVudDsgZmlsZW5hbWU9InVzZXItZGF0YS50eHQiCgojIS9iaW4vYmFzaApleGVjID4gPih0ZWUgLWEgL3Zhci9sb2cvZWItY2ZuLWluaXQubG9nfGxvZ2dlciAtdCBbZWItY2ZuLWluaXRdIC1zIDI",
"blockDeviceMappings": [{"deviceName": "/dev/xvdcz",
"ebs": {"deleteOnTermination": true,
"volumeSize": 12,
"volumeType": "gp2"
}
}
]
}
}
}
}
],
"count": 1,
"kind": "spotinst:aws:ec2:group"
}
}

Create CodeDeploy B/G Deployment

Trigger a Blue-Green deployment to your Elastigroup, this will initiate a deployment that will replace the existing instances(blue) with new ones(green).

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

Elastigroup ID

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

object

	Array of objects[ items ]
	Array of objects[ items ]
timeout	integer

Responses

Request samples

Payload

Content type

application/json

{"deployment": {"timeout": 20,
"tags": [{"tagKey": "ver",
"tagValue": "pink"
}
],
"deploymentGroups": [{"applicationName": "appTest",
"deploymentGroupName": "deploymentGroupName"
}
]
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "cdbg-3ccf1234",
"groupId": "sig-87231234",
"state": "STARTING",
"config": {"timeout": 20,
"tags": [{"tagKey": "ver",
"tagValue": "pink"
}
],
"deploymentGroups": [{"applicationName": "appTest",
"deploymentGroupName": "deploymentGroupName"
}
]
}
}
],
"count": 1,
"kind": "spotinst:aws:ec2:group:codeDeploy:blueGreenDeployment"
}
}

Get CodeDeploy B/G Deployment

Get CodeDeploy Elastigroup deployment status for more information see: CodeDeploy B/G Deployment

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

Elastigroup ID

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

object

	Array of objects[ items ]
	Array of objects[ items ]
timeout	integer

Responses

Request samples

Payload

Content type

application/json

{"deployment": {"timeout": 20,
"tags": [{"tagKey": "ver",
"tagValue": "pink"
}
],
"deploymentGroups": [{"applicationName": "appTest",
"deploymentGroupName": "deploymentGroupName"
}
]
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "cdbg-3ccf1234",
"groupId": "sig-87231234",
"state": "STARTING",
"config": {"timeout": 20,
"tags": [{"tagKey": "ver",
"tagValue": "pink"
}
],
"deploymentGroups": [{"applicationName": "appTest",
"deploymentGroupName": "deploymentGroupName"
}
]
}
}
],
"count": 1,
"kind": "spotinst:aws:ec2:group:codeDeploy:blueGreenDeployment"
}
}

List Elastigroup ITF Listener Rule Migrations

Get all ITF listener rule migrations of a specific Elastigroup.

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

The Spot Elastigroup ID you want to update

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/aws/ec2/group/sig-12345/itf/migration?spotinstAccountId=act-123456",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"createdAt": "2020-04-10T21:41:31.000Z",
"updatedAt": "2020-05-12T22:37:18.000Z",
"id": "ilrm-12345678",
"groupId": "sig-12345",
"ruleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/0123456789012345/1234567890123456/234567890123456",
"status": "Starting"
}
],
"count": 1,
"kind": "spotinst:aws:ec2:group:itf:migration"
}
}

Update ITF Listener Rule Migration

Update an ITF listener rule migration object of a specific Elastigroup.

Authorizations:

path Parameters

groupId required	string Example: sig-12345 The Spot Elastigroup ID you want to update
migrationId required	string Example: ilrm-12345678 The ID of the ITF listener rule migration to be updated.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

status

string

Value: "USER_RETRY"

The status to be updated. Valid value is "USER_RETRY".

Responses

Request samples

Payload

Content type

application/json

{"status": "USER_RETRY"
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/aws/ec2/group/sig-12345/itf/migration/ilrm-12345678?spotinstAccountId=act-123456",
"method": "UPDATE",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"createdAt": "2020-04-10T21:41:31.000Z",
"updatedAt": "2020-05-12T22:37:18.000Z",
"id": "ilrm-12345678",
"groupId": "sig-12345",
"ruleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/0123456789012345/1234567890123456/234567890123456",
"status": "Starting"
}
],
"count": 1,
"kind": "spotinst:aws:ec2:group:itf:migration"
}
}

Elastigroup AWS EMR Scaler

List All Scalers

List all MR Scalers and their configuration.

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"mrScaler": {"name": "my MRScaler",
"description": "this is an MRScaler created with Spot",
"region": "us-west-2",
"strategy": {"wrapping": {"sourceClusterId": "c-1234"
},
"new": {"releaseLabel": "emr-5.17.0",
"numberOfRetries": 5
},
"cloning": {"originClusterId": "j-38EE27G2QY02I",
"includeSteps": false,
"numberOfRetries": 5
},
"provisioningTimeout": {"timeout": 15,
"timeoutAction": "terminate"
}
},
"compute": {"ebsRootVolumeSize": 4,
"availabilityZones": [{"name": "us-west-2a",
"subnetId": "subnet-3b5b3601"
}
],
"bootstrapActions": {"file": {"bucket": "emr-test",
"key": "MyFile.json"
}
},
"steps": {"file": {"bucket": "emr-test",
"key": "MyFile.json"
}
},
"instanceGroups": [{"masterGroup": {"instanceTypes": ["m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"target": 1,
"lifeCycle": "SPOT",
"configurations": [{"classification": "mapred-site",
"properties": {"mapred.tasktracker.map.tasks.maximum": 2
},
"configuartions": [{"classification": "hadoop-env",
"properties": {"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"coreGroup": {"instanceTypes": ["m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"capacity": {"minimum": 1,
"target": 5,
"maximum": 10,
"unit": "instance"
},
"lifeCycle": "SPOT",
"ebsConfiguration": {"ebsBlockDeviceConfigs": [{"volumeSpecification": {"volumeType": "io1",
"dynamicVolumeSize": {"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
},
"sizeInGB": 8,
"iops": 200
},
"volumesPerInstance": 1
}
],
"ebsOptimized": true
},
"configurations": [{"classification": "mapred-site",
"properties": {"mapred.tasktracker.map.tasks.maximum": 2
},
"configuartions": [{"classification": "hadoop-env",
"properties": {"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"taskGroup": {"instanceTypes": ["m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"capacity": {"minimum": 1,
"target": 5,
"maximum": 10,
"unit": "instance"
},
"lifeCycle": "SPOT",
"ebsConfiguration": {"ebsBlockDeviceConfigs": [{"volumeSpecification": {"volumeType": "io1",
"dynamicVolumeSize": {"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
},
"sizeInGB": 8,
"iops": 200
},
"volumesPerInstance": 1
}
],
"ebsOptimized": true
},
"configurations": [{"classification": "mapred-site",
"properties": {"mapred.tasktracker.map.tasks.maximum": 2
},
"configuartions": [{"classification": "hadoop-env",
"properties": {"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
}
}
],
"instanceWeights": [{"instanceType": "m4.large",
"weightedCapacity": 3
}
],
"emrManagedMasterSecurityGroup": "sg-123456789",
"emrManagedSlaveSecurityGroup": "sg-123456789",
"additionalMasterSecurityGroups": ["sg-123456789"
],
"additionalSlaveSecurityGroups": ["sg-123456789"
],
"serviceAccessSecurityGroup": "EMR_DefaultRole",
"customAmiId": "ami-123456789",
"repoUpgradeOnBoot": "SECURITY",
"tags": [{"tagKey": "Creator",
"tagValue": "someUser"
}
],
"ec2KeyName": "myEC2KeyName",
"applications": [{"name": "Hue",
"args": ["string"
],
"version": "1.0"
}
],
"configurations": [{"classification": "mapred-site",
"properties": {"mapred.tasktracker.map.tasks.maximum": 2
},
"configuartions": [{"classification": "hadoop-env",
"properties": {"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"cluster": {"terminationProtected": false,
"keepJobFlowAliveWhenNoSteps": true,
"logUri": "s3://job-status",
"additionalInfo": "{'test':'more information'}",
"jobFlowRole": "EMR_EC2_DefaultRole",
"serviceRole": "someIAMRole",
"securityConfiguration": "testConfig"
},
"scheduling": {"tasks": [{"isEnabled": true,
"instanceGroupType": "task",
"taskType": "setCapacity",
"cronExpression": "* 8 * 10 *",
"targetCapacity": 2,
"minCapacity": 2,
"maxCapacity": 2
}
]
},
"scaling": {"up": [{"policyName": "myScaleUpPolicyName",
"metricName": "AppsPending",
"unit": "count",
"threshold": 100,
"action": {"type": "adjustment",
"minTargetCapacity": 1,
"adjustment": 2,
"target": 2,
"minimum": 1,
"maximum": 5
},
"adjustment": 2,
"period": 300,
"evaluationPeriods": 1,
"dimensions": [{"name": "JobFlowId"
}
],
"operator": "gte",
"statistic": "average",
"namespace": "AWS/ElasticMapReduce"
}
],
"down": [{"policyName": "myScaleDownPolicyName",
"metricName": "AppsPending",
"unit": "count",
"threshold": 100,
"action": {"type": "adjustment",
"maxTargetCapacity": 1,
"adjustment": 2,
"target": 2,
"minimum": 1,
"maximum": 5
},
"adjustment": 2,
"period": 300,
"evaluationPeriods": 1,
"dimensions": [{"name": "JobFlowId"
}
],
"operator": "lte",
"statistic": "average",
"namespace": "AWS/ElasticMapReduce"
}
]
},
"terminationPolicies": [{"statements": [{"namespace": "AWS/ElasticMapReduce",
"metricName": "AppsRunning",
"statistic": "average",
"unit": "count",
"threshold": 2,
"period": 300,
"evaluationPeriods": 1,
"operator": "gte"
}
]
}
]
},
"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-11-01T10:50:29.000+0000"
}
],
"count": 1,
"kind": "spotinst:aws:emr:mrScaler"
}
}

Create Scaler

Create a new EMR cluster.

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

required

object

	object (EMR Cluster Object) Allowed only when the `new` strategy is chosen.
	object (Compute Object) describes the compute resources for the MR scaler
description	string description for the MRScaler
name required	string MRScaler name
region required	string The region of the source cluster
	object (Scaling Object) Set scaling polices.
	object (Scheduling Object) Schedule tasks to execute on the Elastigroup.
required	object (Strategy Object) The strategy for creating the group. At least one of `wrapping`, `cloning`, or `new` is required.
	Array of objects (Termination Policy Object) [ items ] Termination policies for EMR clusters based on CloudWatch Metrics.

Responses

Request samples

Payload

Content type

application/json

{"mrScaler": {"name": "my MRScaler",
"description": "this is an MRScaler created with Spot",
"region": "us-west-2",
"strategy": {"wrapping": {"sourceClusterId": "c-1234"
},
"new": {"releaseLabel": "emr-5.17.0",
"numberOfRetries": 5
},
"cloning": {"originClusterId": "j-38EE27G2QY02I",
"includeSteps": false,
"numberOfRetries": 5
},
"provisioningTimeout": {"timeout": 15,
"timeoutAction": "terminate"
}
},
"compute": {"ebsRootVolumeSize": 4,
"availabilityZones": [{"name": "us-west-2a",
"subnetId": "subnet-3b5b3601"
}
],
"bootstrapActions": {"file": {"bucket": "emr-test",
"key": "MyFile.json"
}
},
"steps": {"file": {"bucket": "emr-test",
"key": "MyFile.json"
}
},
"instanceGroups": [{"masterGroup": {"instanceTypes": ["m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"target": 1,
"lifeCycle": "SPOT",
"configurations": [{"classification": "mapred-site",
"properties": {"mapred.tasktracker.map.tasks.maximum": 2
},
"configuartions": [{"classification": "hadoop-env",
"properties": {"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"coreGroup": {"instanceTypes": ["m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"capacity": {"minimum": 1,
"target": 5,
"maximum": 10,
"unit": "instance"
},
"lifeCycle": "SPOT",
"ebsConfiguration": {"ebsBlockDeviceConfigs": [{"volumeSpecification": {"volumeType": "io1",
"dynamicVolumeSize": {"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
},
"sizeInGB": 8,
"iops": 200
},
"volumesPerInstance": 1
}
],
"ebsOptimized": true
},
"configurations": [{"classification": "mapred-site",
"properties": {"mapred.tasktracker.map.tasks.maximum": 2
},
"configuartions": [{"classification": "hadoop-env",
"properties": {"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"taskGroup": {"instanceTypes": ["m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"capacity": {"minimum": 1,
"target": 5,
"maximum": 10,
"unit": "instance"
},
"lifeCycle": "SPOT",
"ebsConfiguration": {"ebsBlockDeviceConfigs": [{"volumeSpecification": {"volumeType": "io1",
"dynamicVolumeSize": {"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
},
"sizeInGB": 8,
"iops": 200
},
"volumesPerInstance": 1
}
],
"ebsOptimized": true
},
"configurations": [{"classification": "mapred-site",
"properties": {"mapred.tasktracker.map.tasks.maximum": 2
},
"configuartions": [{"classification": "hadoop-env",
"properties": {"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
}
}
],
"instanceWeights": [{"instanceType": "m4.large",
"weightedCapacity": 3
}
],
"emrManagedMasterSecurityGroup": "sg-123456789",
"emrManagedSlaveSecurityGroup": "sg-123456789",
"additionalMasterSecurityGroups": ["sg-123456789"
],
"additionalSlaveSecurityGroups": ["sg-123456789"
],
"serviceAccessSecurityGroup": "EMR_DefaultRole",
"customAmiId": "ami-123456789",
"repoUpgradeOnBoot": "SECURITY",
"tags": [{"tagKey": "Creator",
"tagValue": "someUser"
}
],
"ec2KeyName": "myEC2KeyName",
"applications": [{"name": "Hue",
"args": ["string"
],
"version": "1.0"
}
],
"configurations": [{"classification": "mapred-site",
"properties": {"mapred.tasktracker.map.tasks.maximum": 2
},
"configuartions": [{"classification": "hadoop-env",
"properties": {"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"cluster": {"terminationProtected": false,
"keepJobFlowAliveWhenNoSteps": true,
"logUri": "s3://job-status",
"additionalInfo": "{'test':'more information'}",
"jobFlowRole": "EMR_EC2_DefaultRole",
"serviceRole": "someIAMRole",
"securityConfiguration": "testConfig"
},
"scheduling": {"tasks": [{"isEnabled": true,
"instanceGroupType": "task",
"taskType": "setCapacity",
"cronExpression": "* 8 * 10 *",
"targetCapacity": 2,
"minCapacity": 2,
"maxCapacity": 2
}
]
},
"scaling": {"up": [{"policyName": "myScaleUpPolicyName",
"metricName": "AppsPending",
"unit": "count",
"threshold": 100,
"action": {"type": "adjustment",
"minTargetCapacity": 1,
"adjustment": 2,
"target": 2,
"minimum": 1,
"maximum": 5
},
"adjustment": 2,
"period": 300,
"evaluationPeriods": 1,
"dimensions": [{"name": "JobFlowId"
}
],
"operator": "gte",
"statistic": "average",
"namespace": "AWS/ElasticMapReduce"
}
],
"down": [{"policyName": "myScaleDownPolicyName",
"metricName": "AppsPending",
"unit": "count",
"threshold": 100,
"action": {"type": "adjustment",
"maxTargetCapacity": 1,
"adjustment": 2,
"target": 2,
"minimum": 1,
"maximum": 5
},
"adjustment": 2,
"period": 300,
"evaluationPeriods": 1,
"dimensions": [{"name": "JobFlowId"
}
],
"operator": "lte",
"statistic": "average",
"namespace": "AWS/ElasticMapReduce"
}
]
},
"terminationPolicies": [{"statements": [{"namespace": "AWS/ElasticMapReduce",
"metricName": "AppsRunning",
"statistic": "average",
"unit": "count",
"threshold": 2,
"period": 300,
"evaluationPeriods": 1,
"operator": "gte"
}
]
}
]
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"mrScaler": {"name": "my MRScaler",
"description": "this is an MRScaler created with Spot",
"region": "us-west-2",
"strategy": {"wrapping": {"sourceClusterId": "c-1234"
},
"new": {"releaseLabel": "emr-5.17.0",
"numberOfRetries": 5
},
"cloning": {"originClusterId": "j-38EE27G2QY02I",
"includeSteps": false,
"numberOfRetries": 5
},
"provisioningTimeout": {"timeout": 15,
"timeoutAction": "terminate"
}
},
"compute": {"ebsRootVolumeSize": 4,
"availabilityZones": [{"name": "us-west-2a",
"subnetId": "subnet-3b5b3601"
}
],
"bootstrapActions": {"file": {"bucket": "emr-test",
"key": "MyFile.json"
}
},
"steps": {"file": {"bucket": "emr-test",
"key": "MyFile.json"
}
},
"instanceGroups": [{"masterGroup": {"instanceTypes": ["m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"target": 1,
"lifeCycle": "SPOT",
"configurations": [{"classification": "mapred-site",
"properties": {"mapred.tasktracker.map.tasks.maximum": 2
},
"configuartions": [{"classification": "hadoop-env",
"properties": {"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"coreGroup": {"instanceTypes": ["m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"capacity": {"minimum": 1,
"target": 5,
"maximum": 10,
"unit": "instance"
},
"lifeCycle": "SPOT",
"ebsConfiguration": {"ebsBlockDeviceConfigs": [{"volumeSpecification": {"volumeType": "io1",
"dynamicVolumeSize": {"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
},
"sizeInGB": 8,
"iops": 200
},
"volumesPerInstance": 1
}
],
"ebsOptimized": true
},
"configurations": [{"classification": "mapred-site",
"properties": {"mapred.tasktracker.map.tasks.maximum": 2
},
"configuartions": [{"classification": "hadoop-env",
"properties": {"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"taskGroup": {"instanceTypes": ["m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"capacity": {"minimum": 1,
"target": 5,
"maximum": 10,
"unit": "instance"
},
"lifeCycle": "SPOT",
"ebsConfiguration": {"ebsBlockDeviceConfigs": [{"volumeSpecification": {"volumeType": "io1",
"dynamicVolumeSize": {"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
},
"sizeInGB": 8,
"iops": 200
},
"volumesPerInstance": 1
}
],
"ebsOptimized": true
},
"configurations": [{"classification": "mapred-site",
"properties": {"mapred.tasktracker.map.tasks.maximum": 2
},
"configuartions": [{"classification": "hadoop-env",
"properties": {"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
}
}
],
"instanceWeights": [{"instanceType": "m4.large",
"weightedCapacity": 3
}
],
"emrManagedMasterSecurityGroup": "sg-123456789",
"emrManagedSlaveSecurityGroup": "sg-123456789",
"additionalMasterSecurityGroups": ["sg-123456789"
],
"additionalSlaveSecurityGroups": ["sg-123456789"
],
"serviceAccessSecurityGroup": "EMR_DefaultRole",
"customAmiId": "ami-123456789",
"repoUpgradeOnBoot": "SECURITY",
"tags": [{"tagKey": "Creator",
"tagValue": "someUser"
}
],
"ec2KeyName": "myEC2KeyName",
"applications": [{"name": "Hue",
"args": ["string"
],
"version": "1.0"
}
],
"configurations": [{"classification": "mapred-site",
"properties": {"mapred.tasktracker.map.tasks.maximum": 2
},
"configuartions": [{"classification": "hadoop-env",
"properties": {"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"cluster": {"terminationProtected": false,
"keepJobFlowAliveWhenNoSteps": true,
"logUri": "s3://job-status",
"additionalInfo": "{'test':'more information'}",
"jobFlowRole": "EMR_EC2_DefaultRole",
"serviceRole": "someIAMRole",
"securityConfiguration": "testConfig"
},
"scheduling": {"tasks": [{"isEnabled": true,
"instanceGroupType": "task",
"taskType": "setCapacity",
"cronExpression": "* 8 * 10 *",
"targetCapacity": 2,
"minCapacity": 2,
"maxCapacity": 2
}
]
},
"scaling": {"up": [{"policyName": "myScaleUpPolicyName",
"metricName": "AppsPending",
"unit": "count",
"threshold": 100,
"action": {"type": "adjustment",
"minTargetCapacity": 1,
"adjustment": 2,
"target": 2,
"minimum": 1,
"maximum": 5
},
"adjustment": 2,
"period": 300,
"evaluationPeriods": 1,
"dimensions": [{"name": "JobFlowId"
}
],
"operator": "gte",
"statistic": "average",
"namespace": "AWS/ElasticMapReduce"
}
],
"down": [{"policyName": "myScaleDownPolicyName",
"metricName": "AppsPending",
"unit": "count",
"threshold": 100,
"action": {"type": "adjustment",
"maxTargetCapacity": 1,
"adjustment": 2,
"target": 2,
"minimum": 1,
"maximum": 5
},
"adjustment": 2,
"period": 300,
"evaluationPeriods": 1,
"dimensions": [{"name": "JobFlowId"
}
],
"operator": "lte",
"statistic": "average",
"namespace": "AWS/ElasticMapReduce"
}
]
},
"terminationPolicies": [{"statements": [{"namespace": "AWS/ElasticMapReduce",
"metricName": "AppsRunning",
"statistic": "average",
"unit": "count",
"threshold": 2,
"period": 300,
"evaluationPeriods": 1,
"operator": "gte"
}
]
}
]
}
}
],
"count": 1,
"kind": "spotinst:aws:emr:mrScaler"
}
}

Create Scaler Operator

mrScaler – required will have the same configuration as in createMrScaler with one exception: we will only work with strategy of “new”, no “clone”/”warp” will be allowed.

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

required	object
name	string

Responses

Request samples

Payload

Content type

application/json

{"name": "GuyEmrOperatorTest",
"mrScaler": {"name": "my MRScaler",
"description": "this is an MRScaler created with Spot",
"region": "us-west-2",
"strategy": {"wrapping": {"sourceClusterId": "c-1234"
},
"new": {"releaseLabel": "emr-5.17.0",
"numberOfRetries": 5
},
"cloning": {"originClusterId": "j-38EE27G2QY02I",
"includeSteps": false,
"numberOfRetries": 5
},
"provisioningTimeout": {"timeout": 15,
"timeoutAction": "terminate"
}
},
"compute": {"ebsRootVolumeSize": 4,
"availabilityZones": [{"name": "us-west-2a",
"subnetId": "subnet-3b5b3601"
}
],
"bootstrapActions": {"file": {"bucket": "emr-test",
"key": "MyFile.json"
}
},
"steps": {"file": {"bucket": "emr-test",
"key": "MyFile.json"
}
},
"instanceGroups": [{"masterGroup": {"instanceTypes": ["m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"target": 1,
"lifeCycle": "SPOT",
"configurations": [{"classification": "mapred-site",
"properties": {"mapred.tasktracker.map.tasks.maximum": 2
},
"configuartions": [{"classification": "hadoop-env",
"properties": {"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"coreGroup": {"instanceTypes": ["m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"capacity": {"minimum": 1,
"target": 5,
"maximum": 10,
"unit": "instance"
},
"lifeCycle": "SPOT",
"ebsConfiguration": {"ebsBlockDeviceConfigs": [{"volumeSpecification": {"volumeType": "io1",
"dynamicVolumeSize": {"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
},
"sizeInGB": 8,
"iops": 200
},
"volumesPerInstance": 1
}
],
"ebsOptimized": true
},
"configurations": [{"classification": "mapred-site",
"properties": {"mapred.tasktracker.map.tasks.maximum": 2
},
"configuartions": [{"classification": "hadoop-env",
"properties": {"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"taskGroup": {"instanceTypes": ["m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"capacity": {"minimum": 1,
"target": 5,
"maximum": 10,
"unit": "instance"
},
"lifeCycle": "SPOT",
"ebsConfiguration": {"ebsBlockDeviceConfigs": [{"volumeSpecification": {"volumeType": "io1",
"dynamicVolumeSize": {"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
},
"sizeInGB": 8,
"iops": 200
},
"volumesPerInstance": 1
}
],
"ebsOptimized": true
},
"configurations": [{"classification": "mapred-site",
"properties": {"mapred.tasktracker.map.tasks.maximum": 2
},
"configuartions": [{"classification": "hadoop-env",
"properties": {"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
}
}
],
"instanceWeights": [{"instanceType": "m4.large",
"weightedCapacity": 3
}
],
"emrManagedMasterSecurityGroup": "sg-123456789",
"emrManagedSlaveSecurityGroup": "sg-123456789",
"additionalMasterSecurityGroups": ["sg-123456789"
],
"additionalSlaveSecurityGroups": ["sg-123456789"
],
"serviceAccessSecurityGroup": "EMR_DefaultRole",
"customAmiId": "ami-123456789",
"repoUpgradeOnBoot": "SECURITY",
"tags": [{"tagKey": "Creator",
"tagValue": "someUser"
}
],
"ec2KeyName": "myEC2KeyName",
"applications": [{"name": "Hue",
"args": ["string"
],
"version": "1.0"
}
],
"configurations": [{"classification": "mapred-site",
"properties": {"mapred.tasktracker.map.tasks.maximum": 2
},
"configuartions": [{"classification": "hadoop-env",
"properties": {"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"cluster": {"terminationProtected": false,
"keepJobFlowAliveWhenNoSteps": true,
"logUri": "s3://job-status",
"additionalInfo": "{'test':'more information'}",
"jobFlowRole": "EMR_EC2_DefaultRole",
"serviceRole": "someIAMRole",
"securityConfiguration": "testConfig"
},
"scheduling": {"tasks": [{"isEnabled": true,
"instanceGroupType": "task",
"taskType": "setCapacity",
"cronExpression": "* 8 * 10 *",
"targetCapacity": 2,
"minCapacity": 2,
"maxCapacity": 2
}
]
},
"scaling": {"up": [{"policyName": "myScaleUpPolicyName",
"metricName": "AppsPending",
"unit": "count",
"threshold": 100,
"action": {"type": "adjustment",
"minTargetCapacity": 1,
"adjustment": 2,
"target": 2,
"minimum": 1,
"maximum": 5
},
"adjustment": 2,
"period": 300,
"evaluationPeriods": 1,
"dimensions": [{"name": "JobFlowId"
}
],
"operator": "gte",
"statistic": "average",
"namespace": "AWS/ElasticMapReduce"
}
],
"down": [{"policyName": "myScaleDownPolicyName",
"metricName": "AppsPending",
"unit": "count",
"threshold": 100,
"action": {"type": "adjustment",
"maxTargetCapacity": 1,
"adjustment": 2,
"target": 2,
"minimum": 1,
"maximum": 5
},
"adjustment": 2,
"period": 300,
"evaluationPeriods": 1,
"dimensions": [{"name": "JobFlowId"
}
],
"operator": "lte",
"statistic": "average",
"namespace": "AWS/ElasticMapReduce"
}
]
},
"terminationPolicies": [{"statements": [{"namespace": "AWS/ElasticMapReduce",
"metricName": "AppsRunning",
"statistic": "average",
"unit": "count",
"threshold": 2,
"period": 300,
"evaluationPeriods": 1,
"operator": "gte"
}
]
}
]
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"mrScaler": {"name": "my MRScaler",
"description": "this is an MRScaler created with Spot",
"region": "us-west-2",
"strategy": {"wrapping": {"sourceClusterId": "c-1234"
},
"new": {"releaseLabel": "emr-5.17.0",
"numberOfRetries": 5
},
"cloning": {"originClusterId": "j-38EE27G2QY02I",
"includeSteps": false,
"numberOfRetries": 5
},
"provisioningTimeout": {"timeout": 15,
"timeoutAction": "terminate"
}
},
"compute": {"ebsRootVolumeSize": 4,
"availabilityZones": [{"name": "us-west-2a",
"subnetId": "subnet-3b5b3601"
}
],
"bootstrapActions": {"file": {"bucket": "emr-test",
"key": "MyFile.json"
}
},
"steps": {"file": {"bucket": "emr-test",
"key": "MyFile.json"
}
},
"instanceGroups": [{"masterGroup": {"instanceTypes": ["m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"target": 1,
"lifeCycle": "SPOT",
"configurations": [{"classification": "mapred-site",
"properties": {"mapred.tasktracker.map.tasks.maximum": 2
},
"configuartions": [{"classification": "hadoop-env",
"properties": {"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"coreGroup": {"instanceTypes": ["m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"capacity": {"minimum": 1,
"target": 5,
"maximum": 10,
"unit": "instance"
},
"lifeCycle": "SPOT",
"ebsConfiguration": {"ebsBlockDeviceConfigs": [{"volumeSpecification": {"volumeType": "io1",
"dynamicVolumeSize": {"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
},
"sizeInGB": 8,
"iops": 200
},
"volumesPerInstance": 1
}
],
"ebsOptimized": true
},
"configurations": [{"classification": "mapred-site",
"properties": {"mapred.tasktracker.map.tasks.maximum": 2
},
"configuartions": [{"classification": "hadoop-env",
"properties": {"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"taskGroup": {"instanceTypes": ["m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"capacity": {"minimum": 1,
"target": 5,
"maximum": 10,
"unit": "instance"
},
"lifeCycle": "SPOT",
"ebsConfiguration": {"ebsBlockDeviceConfigs": [{"volumeSpecification": {"volumeType": "io1",
"dynamicVolumeSize": {"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
},
"sizeInGB": 8,
"iops": 200
},
"volumesPerInstance": 1
}
],
"ebsOptimized": true
},
"configurations": [{"classification": "mapred-site",
"properties": {"mapred.tasktracker.map.tasks.maximum": 2
},
"configuartions": [{"classification": "hadoop-env",
"properties": {"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
}
}
],
"instanceWeights": [{"instanceType": "m4.large",
"weightedCapacity": 3
}
],
"emrManagedMasterSecurityGroup": "sg-123456789",
"emrManagedSlaveSecurityGroup": "sg-123456789",
"additionalMasterSecurityGroups": ["sg-123456789"
],
"additionalSlaveSecurityGroups": ["sg-123456789"
],
"serviceAccessSecurityGroup": "EMR_DefaultRole",
"customAmiId": "ami-123456789",
"repoUpgradeOnBoot": "SECURITY",
"tags": [{"tagKey": "Creator",
"tagValue": "someUser"
}
],
"ec2KeyName": "myEC2KeyName",
"applications": [{"name": "Hue",
"args": ["string"
],
"version": "1.0"
}
],
"configurations": [{"classification": "mapred-site",
"properties": {"mapred.tasktracker.map.tasks.maximum": 2
},
"configuartions": [{"classification": "hadoop-env",
"properties": {"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"cluster": {"terminationProtected": false,
"keepJobFlowAliveWhenNoSteps": true,
"logUri": "s3://job-status",
"additionalInfo": "{'test':'more information'}",
"jobFlowRole": "EMR_EC2_DefaultRole",
"serviceRole": "someIAMRole",
"securityConfiguration": "testConfig"
},
"scheduling": {"tasks": [{"isEnabled": true,
"instanceGroupType": "task",
"taskType": "setCapacity",
"cronExpression": "* 8 * 10 *",
"targetCapacity": 2,
"minCapacity": 2,
"maxCapacity": 2
}
]
},
"scaling": {"up": [{"policyName": "myScaleUpPolicyName",
"metricName": "AppsPending",
"unit": "count",
"threshold": 100,
"action": {"type": "adjustment",
"minTargetCapacity": 1,
"adjustment": 2,
"target": 2,
"minimum": 1,
"maximum": 5
},
"adjustment": 2,
"period": 300,
"evaluationPeriods": 1,
"dimensions": [{"name": "JobFlowId"
}
],
"operator": "gte",
"statistic": "average",
"namespace": "AWS/ElasticMapReduce"
}
],
"down": [{"policyName": "myScaleDownPolicyName",
"metricName": "AppsPending",
"unit": "count",
"threshold": 100,
"action": {"type": "adjustment",
"maxTargetCapacity": 1,
"adjustment": 2,
"target": 2,
"minimum": 1,
"maximum": 5
},
"adjustment": 2,
"period": 300,
"evaluationPeriods": 1,
"dimensions": [{"name": "JobFlowId"
}
],
"operator": "lte",
"statistic": "average",
"namespace": "AWS/ElasticMapReduce"
}
]
},
"terminationPolicies": [{"statements": [{"namespace": "AWS/ElasticMapReduce",
"metricName": "AppsRunning",
"statistic": "average",
"unit": "count",
"threshold": 2,
"period": 300,
"evaluationPeriods": 1,
"operator": "gte"
}
]
}
]
}
}
],
"count": 1,
"kind": "spotinst:aws:emr:mrScaler"
}
}

Get Scaler

Get a description of a specific MR Scaler and its configuration.

Authorizations:

path Parameters

mrScalerId

required

string

Example: simrs-12223

The MRScaler ID

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"mrScaler": {"name": "my MRScaler",
"description": "this is an MRScaler created with Spot",
"region": "us-west-2",
"strategy": {"wrapping": {"sourceClusterId": "c-1234"
},
"new": {"releaseLabel": "emr-5.17.0",
"numberOfRetries": 5
},
"cloning": {"originClusterId": "j-38EE27G2QY02I",
"includeSteps": false,
"numberOfRetries": 5
},
"provisioningTimeout": {"timeout": 15,
"timeoutAction": "terminate"
}
},
"compute": {"ebsRootVolumeSize": 4,
"availabilityZones": [{"name": "us-west-2a",
"subnetId": "subnet-3b5b3601"
}
],
"bootstrapActions": {"file": {"bucket": "emr-test",
"key": "MyFile.json"
}
},
"steps": {"file": {"bucket": "emr-test",
"key": "MyFile.json"
}
},
"instanceGroups": [{"masterGroup": {"instanceTypes": ["m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"target": 1,
"lifeCycle": "SPOT",
"configurations": [{"classification": "mapred-site",
"properties": {"mapred.tasktracker.map.tasks.maximum": 2
},
"configuartions": [{"classification": "hadoop-env",
"properties": {"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"coreGroup": {"instanceTypes": ["m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"capacity": {"minimum": 1,
"target": 5,
"maximum": 10,
"unit": "instance"
},
"lifeCycle": "SPOT",
"ebsConfiguration": {"ebsBlockDeviceConfigs": [{"volumeSpecification": {"volumeType": "io1",
"dynamicVolumeSize": {"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
},
"sizeInGB": 8,
"iops": 200
},
"volumesPerInstance": 1
}
],
"ebsOptimized": true
},
"configurations": [{"classification": "mapred-site",
"properties": {"mapred.tasktracker.map.tasks.maximum": 2
},
"configuartions": [{"classification": "hadoop-env",
"properties": {"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"taskGroup": {"instanceTypes": ["m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"capacity": {"minimum": 1,
"target": 5,
"maximum": 10,
"unit": "instance"
},
"lifeCycle": "SPOT",
"ebsConfiguration": {"ebsBlockDeviceConfigs": [{"volumeSpecification": {"volumeType": "io1",
"dynamicVolumeSize": {"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
},
"sizeInGB": 8,
"iops": 200
},
"volumesPerInstance": 1
}
],
"ebsOptimized": true
},
"configurations": [{"classification": "mapred-site",
"properties": {"mapred.tasktracker.map.tasks.maximum": 2
},
"configuartions": [{"classification": "hadoop-env",
"properties": {"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
}
}
],
"instanceWeights": [{"instanceType": "m4.large",
"weightedCapacity": 3
}
],
"emrManagedMasterSecurityGroup": "sg-123456789",
"emrManagedSlaveSecurityGroup": "sg-123456789",
"additionalMasterSecurityGroups": ["sg-123456789"
],
"additionalSlaveSecurityGroups": ["sg-123456789"
],
"serviceAccessSecurityGroup": "EMR_DefaultRole",
"customAmiId": "ami-123456789",
"repoUpgradeOnBoot": "SECURITY",
"tags": [{"tagKey": "Creator",
"tagValue": "someUser"
}
],
"ec2KeyName": "myEC2KeyName",
"applications": [{"name": "Hue",
"args": ["string"
],
"version": "1.0"
}
],
"configurations": [{"classification": "mapred-site",
"properties": {"mapred.tasktracker.map.tasks.maximum": 2
},
"configuartions": [{"classification": "hadoop-env",
"properties": {"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"cluster": {"terminationProtected": false,
"keepJobFlowAliveWhenNoSteps": true,
"logUri": "s3://job-status",
"additionalInfo": "{'test':'more information'}",
"jobFlowRole": "EMR_EC2_DefaultRole",
"serviceRole": "someIAMRole",
"securityConfiguration": "testConfig"
},
"scheduling": {"tasks": [{"isEnabled": true,
"instanceGroupType": "task",
"taskType": "setCapacity",
"cronExpression": "* 8 * 10 *",
"targetCapacity": 2,
"minCapacity": 2,
"maxCapacity": 2
}
]
},
"scaling": {"up": [{"policyName": "myScaleUpPolicyName",
"metricName": "AppsPending",
"unit": "count",
"threshold": 100,
"action": {"type": "adjustment",
"minTargetCapacity": 1,
"adjustment": 2,
"target": 2,
"minimum": 1,
"maximum": 5
},
"adjustment": 2,
"period": 300,
"evaluationPeriods": 1,
"dimensions": [{"name": "JobFlowId"
}
],
"operator": "gte",
"statistic": "average",
"namespace": "AWS/ElasticMapReduce"
}
],
"down": [{"policyName": "myScaleDownPolicyName",
"metricName": "AppsPending",
"unit": "count",
"threshold": 100,
"action": {"type": "adjustment",
"maxTargetCapacity": 1,
"adjustment": 2,
"target": 2,
"minimum": 1,
"maximum": 5
},
"adjustment": 2,
"period": 300,
"evaluationPeriods": 1,
"dimensions": [{"name": "JobFlowId"
}
],
"operator": "lte",
"statistic": "average",
"namespace": "AWS/ElasticMapReduce"
}
]
},
"terminationPolicies": [{"statements": [{"namespace": "AWS/ElasticMapReduce",
"metricName": "AppsRunning",
"statistic": "average",
"unit": "count",
"threshold": 2,
"period": 300,
"evaluationPeriods": 1,
"operator": "gte"
}
]
}
]
},
"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-11-01T10:50:29.000+0000"
}
],
"count": 1,
"kind": "spotinst:aws:emr:mrScaler"
}
}

Update Scaler

Update an MR Scaler. Partial updating is supported.

Authorizations:

path Parameters

mrScalerId

required

string

Example: simrs-12223

The MRScaler ID

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

One of

object

MR Scaler Object - Update Task Capacity

object

maximum	integer
minimum	integer
target	integer

Responses

Request samples

Payload

Content type

application/json

Example

{"mrScaler": {"compute": {"instanceGroups": {"taskGroup": {"capacity": {"maximum": 0,
"target": 0,
"minimum": 0
}
}
}
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"mrScaler": {"name": "my MRScaler",
"description": "this is an MRScaler created with Spot",
"region": "us-west-2",
"strategy": {"wrapping": {"sourceClusterId": "c-1234"
},
"new": {"releaseLabel": "emr-5.17.0",
"numberOfRetries": 5
},
"cloning": {"originClusterId": "j-38EE27G2QY02I",
"includeSteps": false,
"numberOfRetries": 5
},
"provisioningTimeout": {"timeout": 15,
"timeoutAction": "terminate"
}
},
"compute": {"ebsRootVolumeSize": 4,
"availabilityZones": [{"name": "us-west-2a",
"subnetId": "subnet-3b5b3601"
}
],
"bootstrapActions": {"file": {"bucket": "emr-test",
"key": "MyFile.json"
}
},
"steps": {"file": {"bucket": "emr-test",
"key": "MyFile.json"
}
},
"instanceGroups": [{"masterGroup": {"instanceTypes": ["m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"target": 1,
"lifeCycle": "SPOT",
"configurations": [{"classification": "mapred-site",
"properties": {"mapred.tasktracker.map.tasks.maximum": 2
},
"configuartions": [{"classification": "hadoop-env",
"properties": {"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"coreGroup": {"instanceTypes": ["m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"capacity": {"minimum": 1,
"target": 5,
"maximum": 10,
"unit": "instance"
},
"lifeCycle": "SPOT",
"ebsConfiguration": {"ebsBlockDeviceConfigs": [{"volumeSpecification": {"volumeType": "io1",
"dynamicVolumeSize": {"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
},
"sizeInGB": 8,
"iops": 200
},
"volumesPerInstance": 1
}
],
"ebsOptimized": true
},
"configurations": [{"classification": "mapred-site",
"properties": {"mapred.tasktracker.map.tasks.maximum": 2
},
"configuartions": [{"classification": "hadoop-env",
"properties": {"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"taskGroup": {"instanceTypes": ["m3.xlarge",
"m4.large",
"m4.xlarge",
"m4.2xlarge"
],
"capacity": {"minimum": 1,
"target": 5,
"maximum": 10,
"unit": "instance"
},
"lifeCycle": "SPOT",
"ebsConfiguration": {"ebsBlockDeviceConfigs": [{"volumeSpecification": {"volumeType": "io1",
"dynamicVolumeSize": {"baseSize": 50,
"resource": "CPU",
"sizePerResourceUnit": 20
},
"sizeInGB": 8,
"iops": 200
},
"volumesPerInstance": 1
}
],
"ebsOptimized": true
},
"configurations": [{"classification": "mapred-site",
"properties": {"mapred.tasktracker.map.tasks.maximum": 2
},
"configuartions": [{"classification": "hadoop-env",
"properties": {"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
}
}
],
"instanceWeights": [{"instanceType": "m4.large",
"weightedCapacity": 3
}
],
"emrManagedMasterSecurityGroup": "sg-123456789",
"emrManagedSlaveSecurityGroup": "sg-123456789",
"additionalMasterSecurityGroups": ["sg-123456789"
],
"additionalSlaveSecurityGroups": ["sg-123456789"
],
"serviceAccessSecurityGroup": "EMR_DefaultRole",
"customAmiId": "ami-123456789",
"repoUpgradeOnBoot": "SECURITY",
"tags": [{"tagKey": "Creator",
"tagValue": "someUser"
}
],
"ec2KeyName": "myEC2KeyName",
"applications": [{"name": "Hue",
"args": ["string"
],
"version": "1.0"
}
],
"configurations": [{"classification": "mapred-site",
"properties": {"mapred.tasktracker.map.tasks.maximum": 2
},
"configuartions": [{"classification": "hadoop-env",
"properties": {"HADOOP_DATANODE_HEAPSIZE": 2048,
"HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19"
}
}
]
}
]
},
"cluster": {"terminationProtected": false,
"keepJobFlowAliveWhenNoSteps": true,
"logUri": "s3://job-status",
"additionalInfo": "{'test':'more information'}",
"jobFlowRole": "EMR_EC2_DefaultRole",
"serviceRole": "someIAMRole",
"securityConfiguration": "testConfig"
},
"scheduling": {"tasks": [{"isEnabled": true,
"instanceGroupType": "task",
"taskType": "setCapacity",
"cronExpression": "* 8 * 10 *",
"targetCapacity": 2,
"minCapacity": 2,
"maxCapacity": 2
}
]
},
"scaling": {"up": [{"policyName": "myScaleUpPolicyName",
"metricName": "AppsPending",
"unit": "count",
"threshold": 100,
"action": {"type": "adjustment",
"minTargetCapacity": 1,
"adjustment": 2,
"target": 2,
"minimum": 1,
"maximum": 5
},
"adjustment": 2,
"period": 300,
"evaluationPeriods": 1,
"dimensions": [{"name": "JobFlowId"
}
],
"operator": "gte",
"statistic": "average",
"namespace": "AWS/ElasticMapReduce"
}
],
"down": [{"policyName": "myScaleDownPolicyName",
"metricName": "AppsPending",
"unit": "count",
"threshold": 100,
"action": {"type": "adjustment",
"maxTargetCapacity": 1,
"adjustment": 2,
"target": 2,
"minimum": 1,
"maximum": 5
},
"adjustment": 2,
"period": 300,
"evaluationPeriods": 1,
"dimensions": [{"name": "JobFlowId"
}
],
"operator": "lte",
"statistic": "average",
"namespace": "AWS/ElasticMapReduce"
}
]
},
"terminationPolicies": [{"statements": [{"namespace": "AWS/ElasticMapReduce",
"metricName": "AppsRunning",
"statistic": "average",
"unit": "count",
"threshold": 2,
"period": 300,
"evaluationPeriods": 1,
"operator": "gte"
}
]
}
]
},
"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-11-01T10:50:29.000+0000"
}
],
"count": 1,
"kind": "spotinst:aws:emr:mrScaler"
}
}

Delete Scaler

Delete an MR Scaler

Authorizations:

path Parameters

mrScalerId

required

string

Example: simrs-12223

The MRScaler ID

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

List Instances

Get a list of all instances and instances groups in the cluster

Authorizations:

path Parameters

mrScalerId

required

string

Example: simrs-12223

The MRScaler ID

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"instanceId": "i-asdfjk3989",
"instanceGroupId": "ig-asdfjl2",
"instanceGroupRole": "MASTER",
"instanceType": "m1.medium",
"availabilityZone": "us-east-1a",
"status": "Running",
"updatedAt": "2015-08-02T09:11:16.356Z"
}
],
"count": 1,
"kind": "spotinst:aws:emr:mrScaler:instance"
}
}

Scale Up

Scale up MR Scaler instances

Authorizations:

path Parameters

mrScalerId

required

string

Example: simrs-12223

The MRScaler ID

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
adjustment required	integer Example: adjustment=3 Number of instances to add to the MR Scaler

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"modifiedInstanceGroups": ["ig-2470IUVXLJ652S",
"ig-9870IUVXMYYW9"
],
"newInstanceGroups": ["ig-0570LPWAZXBSR3"
]
}
],
"count": 1,
"kind": "spotinst:aws:emr:mrScaler:scale"
}
}

Scale Down

Scale down MR Scaler instances

Authorizations:

path Parameters

mrScalerId

required

string

Example: simrs-12223

The MRScaler ID

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
adjustment required	integer Example: adjustment=3 Number of instances to remove from the MR Scaler

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"modifiedInstanceGroups": ["ig-2470IUVXLJ652S",
"ig-9870IUVXMYYW9"
],
"victimInstances": ["ig-0570LPWAZXBSR3"
]
}
],
"count": 1,
"kind": "spotinst:aws:emr:mrScaler:scale"
}
}

List Scalers

Get MR Scaler cluster

Authorizations:

path Parameters

mrScalerId

required

string

Example: simrs-12223

The MRScaler ID

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "j-3N7WPI3R0D1R7",
"availabilityZone": "us-east-1a",
"state": "terminated",
"createdAt": "2015-08-02T09:11:16.356Z",
"updatedAt": "2015-08-02T10:11:16.356Z"
}
],
"count": 1,
"kind": "spotinst:aws:emr:mrScaler:cluster"
}
}

Get Scaler Costs

Get financial information on the MR Scaler, including running time, costs, and savings

Authorizations:

path Parameters

mrScalerId

required

string

Example: simrs-12223

The MRScaler ID

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
required	unix (string) or dateTime (string) Example: fromDate=2020-09-01 or fromDate=1598918400000 Get items on or after this date (ISO 8601 or Unix timestamp)
required	unix (string) or dateTime (string) Example: toDate=2020-09-01 or toDate=1598918400000 Get items on or before this date (ISO 8601 or Unix timestamp)

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"running": {"value": 294.3,
"unit": "hours"
},
"savings": {"value": 60.5263,
"unit": "percentage"
},
"costs": {"actual": 8.829,
"potential": 22.3668
}
}
],
"count": 1,
"kind": "spotinst:aws:emr:mrScaler:costs"
}
}

Elastigroup GCP

Elastigroup for Google Cloud

List Elastigroups

List all GCP Elastigroups for a Spot Account

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"group": {"id": "sig-1234567",
"name": "spotinst-group",
"description": "Some GCP Elastigroup description",
"capacity": {"target": 8,
"minimum": 2,
"maximum": 20,
"unit": "instance"
},
"scheduling": {"tasks": [{"isEnabled": true,
"taskType": "setCapacity",
"cronExpression": "1 10 * * *",
"targetCapacity": 2,
"minCapacity": 1,
"maxCapacity": 3
}
]
},
"strategy": {"fallbackToOd": true,
"optimizationWindows": [["Mon:01:00-Mon:02:00"
]
],
"provisioningModel": "SPOT",
"revertToPreemptible": {"performAt": "timeWindow"
},
"preemptiblePercentage": 90,
"onDemandCount": 2,
"drainingTimeout": 30
},
"compute": {"launchSpecification": {"metadata": [{"key": "environment",
"value": "production"
}
],
"tags": [["prod1",
"testingfeature"
]
],
"backendServiceConfig": {"backendServices": [{"backendServiceName": "bserv-2",
"locationType": "global",
"scheme": null,
"namedPorts": {"name": "https",
"ports": [[443,
8443
]
]
}
}
]
},
"disks": [{"deviceName": null,
"initializeParams": {"diskSizeGb": 10,
"diskType": "pd-standard",
"sourceImage": "https://www.googleapis.com/compute/v1/projects/test/global/images/docker-image-1"
},
"mode": "READ_WRITE",
"source": null,
"type": "PERSISTENT",
"autoDelete": true,
"boot": true,
"interface": "SCSI"
}
],
"networkInterfaces": [{"network": "spot-network",
"projectId": "test-project"
}
],
"startupScript": "IyEvYmluL2Jhc2gNCnRvdWNoIHRlc3Qiquwhq38",
"shutdownScript": null,
"ipForwarding": false,
"minCpuPlatform": "Intel Sandy Bridge"
},
"instanceTypes": {"ondemand": "n1-standard-1",
"preemptible": ["n1-standard-1",
"n1-standard-2"
],
"custom": {"vCPU": "4",
"memoryGiB": "3.75"
},
"preferred": {"preemptible": ["n1-standard-1",
"n1-standard-2"
],
"custom": {"vCPU": "4",
"memoryGiB": "3.75"
}
}
},
"availabilityZones": ["asia-east1-a",
"asia-east1-b",
"asia-east1-c"
],
"preferredAvailabilityZones": ["asia-east1-a",
"asia-east1-c"
],
"gpu": {"type": "nvidia-tesla-v100",
"count": 1
},
"subnets": [{"region": "us-west1",
"subnetNames": ["private"
]
}
]
},
"scaling": {"up": [{"policyName": "scale_up_1",
"source": "stackdriver",
"metricName": "instance/disk/read_ops_count",
"statistic": "average",
"unit": "percent",
"threshold": 10000,
"namespace": "compute",
"period": 300,
"evaluationPeriods": 1,
"cooldown": 300,
"operator": "gte",
"dimensions": [{"name": "storage_type",
"value": "pd-standard"
}
],
"action": {"type": "adjustment",
"adjustment": 1
}
}
],
"down": [{"policyName": "scale_down_1",
"source": "stackdriver",
"metricName": "instance/disk/read_ops_count",
"statistic": "average",
"unit": "percent",
"threshold": 10000,
"namespace": "compute",
"period": 300,
"evaluationPeriods": 1,
"cooldown": 300,
"operator": "lte",
"dimensions": [{"name": "storage_type",
"value": "pd-standard"
}
],
"action": {"type": "adjustment",
"adjustment": 1
}
}
]
},
"thirdPartiesIntegration": {"dockerSwarm": {"masterHost": "swarm1.swarm.com",
"masterPort": 1234
},
"gke": {"autoUpdate": true,
"autoScale": {"isEnabled": true,
"isAutoConfig": false,
"cooldown": 300,
"headroom": {"cpuPerUnit": 1,
"memoryPerUnit": 0,
"numOfUnits": 1
},
"down": {"evaluationPeriods": 5
}
},
"clusterIdentifier": "gke-clust-1",
"location": "us-west1"
}
},
"createdAt": "2020-10-16T09:03:23.000Z",
"updatedAt": "2020-10-16T09:03:23.000Z"
}
}
],
"count": 1,
"kind": "spotinst:gcp:gce:group"
}
}

Create Elastigroup

Create a new GCP Elastigroup

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

required

object

required	object (Capacity Units)
required	object (Compute Object)
createdAt	string <date-time> The datetime the group was created.
description	string Description for your GCP Elastigroup
name required	string GCP Elastigroup Name
	object (Scaling object)
	object (Scheduling Object)
required	object (Elastigroup Strategy)
	object (Third Parties Integration Object)
updatedAt	string <date-time> The datetime the group was last updated.

Responses

Request samples

Payload

Content type

application/json

{"group": {"name": "spotinst-group",
"description": "Some GCP Elastigroup description",
"capacity": {"target": 8,
"minimum": 2,
"maximum": 20,
"unit": "instance"
},
"scheduling": {"tasks": [{"isEnabled": true,
"taskType": "setCapacity",
"cronExpression": "1 10 * * *",
"targetCapacity": 2,
"minCapacity": 1,
"maxCapacity": 3
}
]
},
"strategy": {"fallbackToOd": true,
"optimizationWindows": [["Mon:01:00-Mon:02:00"
]
],
"provisioningModel": "SPOT",
"revertToPreemptible": {"performAt": "timeWindow"
},
"preemptiblePercentage": 90,
"onDemandCount": 2,
"drainingTimeout": 30
},
"compute": {"launchSpecification": {"metadata": [{"key": "environment",
"value": "production"
}
],
"tags": [["prod1",
"testingfeature"
]
],
"backendServiceConfig": {"backendServices": [{"backendServiceName": "bserv-2",
"locationType": "global",
"scheme": null,
"namedPorts": {"name": "https",
"ports": [[443,
8443
]
]
}
}
]
},
"disks": [{"deviceName": null,
"initializeParams": {"diskSizeGb": 10,
"diskType": "pd-standard",
"sourceImage": "https://www.googleapis.com/compute/v1/projects/test/global/images/docker-image-1"
},
"mode": "READ_WRITE",
"source": null,
"type": "PERSISTENT",
"autoDelete": true,
"boot": true,
"interface": "SCSI"
}
],
"networkInterfaces": [{"network": "spot-network",
"projectId": "test-project"
}
],
"startupScript": "IyEvYmluL2Jhc2gNCnRvdWNoIHRlc3Qiquwhq38",
"shutdownScript": null,
"ipForwarding": false,
"minCpuPlatform": "Intel Sandy Bridge"
},
"instanceTypes": {"ondemand": "n1-standard-1",
"preemptible": ["n1-standard-1",
"n1-standard-2"
],
"custom": {"vCPU": "4",
"memoryGiB": "3.75"
},
"preferred": {"preemptible": ["n1-standard-1",
"n1-standard-2"
],
"custom": {"vCPU": "4",
"memoryGiB": "3.75"
}
}
},
"availabilityZones": ["asia-east1-a",
"asia-east1-b",
"asia-east1-c"
],
"preferredAvailabilityZones": ["asia-east1-a",
"asia-east1-c"
],
"gpu": {"type": "nvidia-tesla-v100",
"count": 1
},
"subnets": [{"region": "us-west1",
"subnetNames": ["private"
]
}
]
},
"scaling": {"up": [{"policyName": "scale_up_1",
"source": "stackdriver",
"metricName": "instance/disk/read_ops_count",
"statistic": "average",
"unit": "percent",
"threshold": 10000,
"namespace": "compute",
"period": 300,
"evaluationPeriods": 1,
"cooldown": 300,
"operator": "gte",
"dimensions": [{"name": "storage_type",
"value": "pd-standard"
}
],
"action": {"type": "adjustment",
"adjustment": 1
}
}
],
"down": [{"policyName": "scale_down_1",
"source": "stackdriver",
"metricName": "instance/disk/read_ops_count",
"statistic": "average",
"unit": "percent",
"threshold": 10000,
"namespace": "compute",
"period": 300,
"evaluationPeriods": 1,
"cooldown": 300,
"operator": "lte",
"dimensions": [{"name": "storage_type",
"value": "pd-standard"
}
],
"action": {"type": "adjustment",
"adjustment": 1
}
}
]
},
"thirdPartiesIntegration": {"dockerSwarm": {"masterHost": "swarm1.swarm.com",
"masterPort": 1234
},
"gke": {"autoUpdate": true,
"autoScale": {"isEnabled": true,
"isAutoConfig": false,
"cooldown": 300,
"headroom": {"cpuPerUnit": 1,
"memoryPerUnit": 0,
"numOfUnits": 1
},
"down": {"evaluationPeriods": 5
}
},
"clusterIdentifier": "gke-clust-1",
"location": "us-west1"
}
},
"createdAt": "2020-10-16T09:03:23.000Z",
"updatedAt": "2020-10-16T09:03:23.000Z"
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"group": {"id": "sig-1234567",
"name": "spotinst-group",
"description": "Some GCP Elastigroup description",
"capacity": {"target": 8,
"minimum": 2,
"maximum": 20,
"unit": "instance"
},
"scheduling": {"tasks": [{"isEnabled": true,
"taskType": "setCapacity",
"cronExpression": "1 10 * * *",
"targetCapacity": 2,
"minCapacity": 1,
"maxCapacity": 3
}
]
},
"strategy": {"fallbackToOd": true,
"optimizationWindows": [["Mon:01:00-Mon:02:00"
]
],
"provisioningModel": "SPOT",
"revertToPreemptible": {"performAt": "timeWindow"
},
"preemptiblePercentage": 90,
"onDemandCount": 2,
"drainingTimeout": 30
},
"compute": {"launchSpecification": {"metadata": [{"key": "environment",
"value": "production"
}
],
"tags": [["prod1",
"testingfeature"
]
],
"backendServiceConfig": {"backendServices": [{"backendServiceName": "bserv-2",
"locationType": "global",
"scheme": null,
"namedPorts": {"name": "https",
"ports": [[443,
8443
]
]
}
}
]
},
"disks": [{"deviceName": null,
"initializeParams": {"diskSizeGb": 10,
"diskType": "pd-standard",
"sourceImage": "https://www.googleapis.com/compute/v1/projects/test/global/images/docker-image-1"
},
"mode": "READ_WRITE",
"source": null,
"type": "PERSISTENT",
"autoDelete": true,
"boot": true,
"interface": "SCSI"
}
],
"networkInterfaces": [{"network": "spot-network",
"projectId": "test-project"
}
],
"startupScript": "IyEvYmluL2Jhc2gNCnRvdWNoIHRlc3Qiquwhq38",
"shutdownScript": null,
"ipForwarding": false,
"minCpuPlatform": "Intel Sandy Bridge"
},
"instanceTypes": {"ondemand": "n1-standard-1",
"preemptible": ["n1-standard-1",
"n1-standard-2"
],
"custom": {"vCPU": "4",
"memoryGiB": "3.75"
},
"preferred": {"preemptible": ["n1-standard-1",
"n1-standard-2"
],
"custom": {"vCPU": "4",
"memoryGiB": "3.75"
}
}
},
"availabilityZones": ["asia-east1-a",
"asia-east1-b",
"asia-east1-c"
],
"preferredAvailabilityZones": ["asia-east1-a",
"asia-east1-c"
],
"gpu": {"type": "nvidia-tesla-v100",
"count": 1
},
"subnets": [{"region": "us-west1",
"subnetNames": ["private"
]
}
]
},
"scaling": {"up": [{"policyName": "scale_up_1",
"source": "stackdriver",
"metricName": "instance/disk/read_ops_count",
"statistic": "average",
"unit": "percent",
"threshold": 10000,
"namespace": "compute",
"period": 300,
"evaluationPeriods": 1,
"cooldown": 300,
"operator": "gte",
"dimensions": [{"name": "storage_type",
"value": "pd-standard"
}
],
"action": {"type": "adjustment",
"adjustment": 1
}
}
],
"down": [{"policyName": "scale_down_1",
"source": "stackdriver",
"metricName": "instance/disk/read_ops_count",
"statistic": "average",
"unit": "percent",
"threshold": 10000,
"namespace": "compute",
"period": 300,
"evaluationPeriods": 1,
"cooldown": 300,
"operator": "lte",
"dimensions": [{"name": "storage_type",
"value": "pd-standard"
}
],
"action": {"type": "adjustment",
"adjustment": 1
}
}
]
},
"thirdPartiesIntegration": {"dockerSwarm": {"masterHost": "swarm1.swarm.com",
"masterPort": 1234
},
"gke": {"autoUpdate": true,
"autoScale": {"isEnabled": true,
"isAutoConfig": false,
"cooldown": 300,
"headroom": {"cpuPerUnit": 1,
"memoryPerUnit": 0,
"numOfUnits": 1
},
"down": {"evaluationPeriods": 5
}
},
"clusterIdentifier": "gke-clust-1",
"location": "us-west1"
}
},
"createdAt": "2020-10-16T09:03:23.000Z",
"updatedAt": "2020-10-16T09:03:23.000Z"
}
}
],
"count": 1,
"kind": "spotinst:gcp:gce:group"
}
}

Get Elastigroup

List all properties for single GCP Elastigroup

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

Elastigroup ID

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"group": {"id": "sig-1234567",
"name": "spotinst-group",
"description": "Some GCP Elastigroup description",
"capacity": {"target": 8,
"minimum": 2,
"maximum": 20,
"unit": "instance"
},
"scheduling": {"tasks": [{"isEnabled": true,
"taskType": "setCapacity",
"cronExpression": "1 10 * * *",
"targetCapacity": 2,
"minCapacity": 1,
"maxCapacity": 3
}
]
},
"strategy": {"fallbackToOd": true,
"optimizationWindows": [["Mon:01:00-Mon:02:00"
]
],
"provisioningModel": "SPOT",
"revertToPreemptible": {"performAt": "timeWindow"
},
"preemptiblePercentage": 90,
"onDemandCount": 2,
"drainingTimeout": 30
},
"compute": {"launchSpecification": {"metadata": [{"key": "environment",
"value": "production"
}
],
"tags": [["prod1",
"testingfeature"
]
],
"backendServiceConfig": {"backendServices": [{"backendServiceName": "bserv-2",
"locationType": "global",
"scheme": null,
"namedPorts": {"name": "https",
"ports": [[443,
8443
]
]
}
}
]
},
"disks": [{"deviceName": null,
"initializeParams": {"diskSizeGb": 10,
"diskType": "pd-standard",
"sourceImage": "https://www.googleapis.com/compute/v1/projects/test/global/images/docker-image-1"
},
"mode": "READ_WRITE",
"source": null,
"type": "PERSISTENT",
"autoDelete": true,
"boot": true,
"interface": "SCSI"
}
],
"networkInterfaces": [{"network": "spot-network",
"projectId": "test-project"
}
],
"startupScript": "IyEvYmluL2Jhc2gNCnRvdWNoIHRlc3Qiquwhq38",
"shutdownScript": null,
"ipForwarding": false,
"minCpuPlatform": "Intel Sandy Bridge"
},
"instanceTypes": {"ondemand": "n1-standard-1",
"preemptible": ["n1-standard-1",
"n1-standard-2"
],
"custom": {"vCPU": "4",
"memoryGiB": "3.75"
},
"preferred": {"preemptible": ["n1-standard-1",
"n1-standard-2"
],
"custom": {"vCPU": "4",
"memoryGiB": "3.75"
}
}
},
"availabilityZones": ["asia-east1-a",
"asia-east1-b",
"asia-east1-c"
],
"preferredAvailabilityZones": ["asia-east1-a",
"asia-east1-c"
],
"gpu": {"type": "nvidia-tesla-v100",
"count": 1
},
"subnets": [{"region": "us-west1",
"subnetNames": ["private"
]
}
]
},
"scaling": {"up": [{"policyName": "scale_up_1",
"source": "stackdriver",
"metricName": "instance/disk/read_ops_count",
"statistic": "average",
"unit": "percent",
"threshold": 10000,
"namespace": "compute",
"period": 300,
"evaluationPeriods": 1,
"cooldown": 300,
"operator": "gte",
"dimensions": [{"name": "storage_type",
"value": "pd-standard"
}
],
"action": {"type": "adjustment",
"adjustment": 1
}
}
],
"down": [{"policyName": "scale_down_1",
"source": "stackdriver",
"metricName": "instance/disk/read_ops_count",
"statistic": "average",
"unit": "percent",
"threshold": 10000,
"namespace": "compute",
"period": 300,
"evaluationPeriods": 1,
"cooldown": 300,
"operator": "lte",
"dimensions": [{"name": "storage_type",
"value": "pd-standard"
}
],
"action": {"type": "adjustment",
"adjustment": 1
}
}
]
},
"thirdPartiesIntegration": {"dockerSwarm": {"masterHost": "swarm1.swarm.com",
"masterPort": 1234
},
"gke": {"autoUpdate": true,
"autoScale": {"isEnabled": true,
"isAutoConfig": false,
"cooldown": 300,
"headroom": {"cpuPerUnit": 1,
"memoryPerUnit": 0,
"numOfUnits": 1
},
"down": {"evaluationPeriods": 5
}
},
"clusterIdentifier": "gke-clust-1",
"location": "us-west1"
}
},
"createdAt": "2020-10-16T09:03:23.000Z",
"updatedAt": "2020-10-16T09:03:23.000Z"
}
}
],
"count": 1,
"kind": "spotinst:gcp:gce:group"
}
}

Delete Elastigroup

Delete an Elastigroup GCP

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

Elastigroup ID

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Update Elastigroup

Update an GCP Elastigroup

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

The Spot Elastigroup ID you want to update

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

required

object

Elastigroup Configuration

	object (Capacity Units) Update capacity settings
	object (Compute Object) Compute Configuration
description	string Description for your GCP Elastigroup
name	string GCP Elastigroup Name
	object (Scaling object) Update scaling settings
	object (Scheduling Object) Schedule tasks to execute, using CRON expressions.
	object (Elastigroup Strategy) Update strategy settings
	object (Third Parties Integration Object) Third Parties Integration Configuration

Responses

Request samples

Payload

Content type

application/json

{"group": {"name": "spotinst-group",
"description": "Some GCP Elastigroup description",
"capacity": {"target": 8,
"minimum": 2,
"maximum": 20
},
"scheduling": {"tasks": [{"isEnabled": true,
"taskType": "setCapacity",
"cronExpression": "1 10 * * *",
"targetCapacity": 2,
"minCapacity": 1,
"maxCapacity": 3
}
]
},
"strategy": {"fallbackToOd": true,
"optimizationWindows": [["Mon:01:00-Mon:02:00"
]
],
"provisioningModel": "SPOT",
"revertToPreemptible": {"performAt": "timeWindow"
},
"preemptiblePercentage": 90,
"onDemandCount": 2,
"drainingTimeout": 30
},
"compute": {"health": {"healthCheckType": "K8S_NODE",
"autoHealing": true,
"gracePeriod": 300,
"unhealthyDuration": 250
},
"launchSpecification": {"metadata": [{"key": "environment",
"value": "production"
}
],
"tags": [["prod1",
"testingfeature"
]
],
"backendServiceConfig": {"backendServices": [{"backendServiceName": "bserv-2",
"locationType": "global",
"scheme": null,
"namedPorts": {"name": "https",
"ports": [[443,
8443
]
]
}
}
]
},
"disks": [{"deviceName": null,
"initializeParams": {"diskSizeGb": 10,
"diskType": "pd-standard",
"sourceImage": "https://www.googleapis.com/compute/v1/projects/test/global/images/docker-image-1"
},
"mode": "READ_WRITE",
"source": null,
"type": "PERSISTENT",
"autoDelete": true,
"boot": true,
"interface": "SCSI"
}
],
"networkInterfaces": [{"network": "spot-network",
"projectId": "test-project"
}
],
"startupScript": "IyEvYmluL2Jhc2gNCnRvdWNoIHRlc3Qiquwhq38",
"shutdownScript": null,
"ipForwarding": false,
"minCpuPlatform": "Intel Sandy Bridge"
},
"instanceTypes": {"ondemand": "n1-standard-1",
"preemptible": ["n1-standard-1",
"n1-standard-2"
],
"custom": {"vCPU": "4",
"memoryGiB": "3.75"
},
"preferred": {"preemptible": ["n1-standard-1",
"n1-standard-2"
],
"custom": {"vCPU": "4",
"memoryGiB": "3.75"
}
}
},
"availabilityZones": ["asia-east1-a",
"asia-east1-b",
"asia-east1-c"
],
"preferredAvailabilityZones": ["asia-east1-a",
"asia-east1-c"
],
"gpu": {"type": "nvidia-tesla-v100",
"count": 1
},
"subnets": [{"region": "us-west1",
"subnetNames": ["private"
]
}
]
},
"scaling": {"up": [{"policyName": "scale_up_1",
"source": "stackdriver",
"metricName": "instance/disk/read_ops_count",
"statistic": "average",
"unit": "percent",
"threshold": 10000,
"namespace": "compute",
"period": 300,
"evaluationPeriods": 1,
"cooldown": 300,
"operator": "lte",
"dimensions": [{"name": "storage_type",
"value": "pd-standard"
}
],
"action": {"type": "adjustment",
"adjustment": 1
}
}
],
"down": [{"policyName": "scale_down_1",
"source": "stackdriver",
"metricName": "instance/disk/read_ops_count",
"statistic": "average",
"unit": "percent",
"threshold": 10000,
"namespace": "compute",
"period": 300,
"evaluationPeriods": 1,
"cooldown": 300,
"operator": "gte",
"dimensions": [{"name": "storage_type",
"value": "pd-standard"
}
],
"action": {"type": "adjustment",
"adjustment": 1
}
}
]
},
"thirdPartiesIntegration": {"dockerSwarm": {"masterHost": "swarm1.swarm.com",
"masterPort": 1234
},
"gke": {"autoUpdate": true,
"autoScale": {"isEnabled": true,
"isAutoConfig": false,
"cooldown": 300,
"headroom": {"cpuPerUnit": 1,
"memoryPerUnit": 0,
"numOfUnits": 1
},
"down": {"evaluationPeriods": 5
}
},
"clusterIdentifier": "gke-clust-1",
"location": "us-west1"
}
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"group": {"id": "sig-1234567",
"name": "spotinst-group",
"description": "Some GCP Elastigroup description",
"capacity": {"target": 8,
"minimum": 2,
"maximum": 20,
"unit": "instance"
},
"scheduling": {"tasks": [{"isEnabled": true,
"taskType": "setCapacity",
"cronExpression": "1 10 * * *",
"targetCapacity": 2,
"minCapacity": 1,
"maxCapacity": 3
}
]
},
"strategy": {"fallbackToOd": true,
"optimizationWindows": [["Mon:01:00-Mon:02:00"
]
],
"provisioningModel": "SPOT",
"revertToPreemptible": {"performAt": "timeWindow"
},
"preemptiblePercentage": 90,
"onDemandCount": 2,
"drainingTimeout": 30
},
"compute": {"launchSpecification": {"metadata": [{"key": "environment",
"value": "production"
}
],
"tags": [["prod1",
"testingfeature"
]
],
"backendServiceConfig": {"backendServices": [{"backendServiceName": "bserv-2",
"locationType": "global",
"scheme": null,
"namedPorts": {"name": "https",
"ports": [[443,
8443
]
]
}
}
]
},
"disks": [{"deviceName": null,
"initializeParams": {"diskSizeGb": 10,
"diskType": "pd-standard",
"sourceImage": "https://www.googleapis.com/compute/v1/projects/test/global/images/docker-image-1"
},
"mode": "READ_WRITE",
"source": null,
"type": "PERSISTENT",
"autoDelete": true,
"boot": true,
"interface": "SCSI"
}
],
"networkInterfaces": [{"network": "spot-network",
"projectId": "test-project"
}
],
"startupScript": "IyEvYmluL2Jhc2gNCnRvdWNoIHRlc3Qiquwhq38",
"shutdownScript": null,
"ipForwarding": false,
"minCpuPlatform": "Intel Sandy Bridge"
},
"instanceTypes": {"ondemand": "n1-standard-1",
"preemptible": ["n1-standard-1",
"n1-standard-2"
],
"custom": {"vCPU": "4",
"memoryGiB": "3.75"
},
"preferred": {"preemptible": ["n1-standard-1",
"n1-standard-2"
],
"custom": {"vCPU": "4",
"memoryGiB": "3.75"
}
}
},
"availabilityZones": ["asia-east1-a",
"asia-east1-b",
"asia-east1-c"
],
"preferredAvailabilityZones": ["asia-east1-a",
"asia-east1-c"
],
"gpu": {"type": "nvidia-tesla-v100",
"count": 1
},
"subnets": [{"region": "us-west1",
"subnetNames": ["private"
]
}
]
},
"scaling": {"up": [{"policyName": "scale_up_1",
"source": "stackdriver",
"metricName": "instance/disk/read_ops_count",
"statistic": "average",
"unit": "percent",
"threshold": 10000,
"namespace": "compute",
"period": 300,
"evaluationPeriods": 1,
"cooldown": 300,
"operator": "gte",
"dimensions": [{"name": "storage_type",
"value": "pd-standard"
}
],
"action": {"type": "adjustment",
"adjustment": 1
}
}
],
"down": [{"policyName": "scale_down_1",
"source": "stackdriver",
"metricName": "instance/disk/read_ops_count",
"statistic": "average",
"unit": "percent",
"threshold": 10000,
"namespace": "compute",
"period": 300,
"evaluationPeriods": 1,
"cooldown": 300,
"operator": "lte",
"dimensions": [{"name": "storage_type",
"value": "pd-standard"
}
],
"action": {"type": "adjustment",
"adjustment": 1
}
}
]
},
"thirdPartiesIntegration": {"dockerSwarm": {"masterHost": "swarm1.swarm.com",
"masterPort": 1234
},
"gke": {"autoUpdate": true,
"autoScale": {"isEnabled": true,
"isAutoConfig": false,
"cooldown": 300,
"headroom": {"cpuPerUnit": 1,
"memoryPerUnit": 0,
"numOfUnits": 1
},
"down": {"evaluationPeriods": 5
}
},
"clusterIdentifier": "gke-clust-1",
"location": "us-west1"
}
},
"createdAt": "2020-10-16T09:03:23.000Z",
"updatedAt": "2020-10-16T09:03:23.000Z"
}
}
],
"count": 1,
"kind": "spotinst:gcp:gce:group"
}
}

Import GKE Cluster

Import an existing GKE cluster to Elastigroup.

Authorizations:

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
clusterId required	string Example: clusterId=myGKECluster The GKE Cluster identifier
clusterLocation required	string Example: clusterLocation=us-central1-a The location of the cluster. Enter the desired zone for zonal GKE clusters or the region for regional GKE clusters.
nodePoolName	string Example: nodePoolName=somePoolName Set the node pool to import

Request Body schema: application/json

required

object

availabilityZones	Array of strings Availability Zone pool to be use for this group
	object Minimum, maximum and target number of vms in the Elastigroup
	object Types and locations of VMs to be utilized
name	string Name of the Elastigroup
preemptiblePercentage	integer Default: 100 Preemptive VMs ratio in the Elastigroup

Responses

Request samples

Payload

Content type

application/json

{"group": {"preemptiblePercentage": 70,
"name": "myGKE",
"capacity": {"minimum": 0,
"maximum": 2,
"target": 1
},
"instanceTypes": {"ondemand": "n1-highcpu-32",
"preemtible": [["n1-standard-1",
"n1-standard-2"
]
]
},
"availabilityZones": [["us-central1-a",
"us-central1-b"
]
]
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"group": {"id": "sig-1234567",
"name": "spotinst-group",
"description": "Some GCP Elastigroup description",
"capacity": {"target": 8,
"minimum": 2,
"maximum": 20,
"unit": "instance"
},
"scheduling": {"tasks": [{"isEnabled": true,
"taskType": "setCapacity",
"cronExpression": "1 10 * * *",
"targetCapacity": 2,
"minCapacity": 1,
"maxCapacity": 3
}
]
},
"strategy": {"fallbackToOd": true,
"optimizationWindows": [["Mon:01:00-Mon:02:00"
]
],
"provisioningModel": "SPOT",
"revertToPreemptible": {"performAt": "timeWindow"
},
"preemptiblePercentage": 90,
"onDemandCount": 2,
"drainingTimeout": 30
},
"compute": {"launchSpecification": {"metadata": [{"key": "environment",
"value": "production"
}
],
"tags": [["prod1",
"testingfeature"
]
],
"backendServiceConfig": {"backendServices": [{"backendServiceName": "bserv-2",
"locationType": "global",
"scheme": null,
"namedPorts": {"name": "https",
"ports": [[443,
8443
]
]
}
}
]
},
"disks": [{"deviceName": null,
"initializeParams": {"diskSizeGb": 10,
"diskType": "pd-standard",
"sourceImage": "https://www.googleapis.com/compute/v1/projects/test/global/images/docker-image-1"
},
"mode": "READ_WRITE",
"source": null,
"type": "PERSISTENT",
"autoDelete": true,
"boot": true,
"interface": "SCSI"
}
],
"networkInterfaces": [{"network": "spot-network",
"projectId": "test-project"
}
],
"startupScript": "IyEvYmluL2Jhc2gNCnRvdWNoIHRlc3Qiquwhq38",
"shutdownScript": null,
"ipForwarding": false,
"minCpuPlatform": "Intel Sandy Bridge"
},
"instanceTypes": {"ondemand": "n1-standard-1",
"preemptible": ["n1-standard-1",
"n1-standard-2"
],
"custom": {"vCPU": "4",
"memoryGiB": "3.75"
},
"preferred": {"preemptible": ["n1-standard-1",
"n1-standard-2"
],
"custom": {"vCPU": "4",
"memoryGiB": "3.75"
}
}
},
"availabilityZones": ["asia-east1-a",
"asia-east1-b",
"asia-east1-c"
],
"preferredAvailabilityZones": ["asia-east1-a",
"asia-east1-c"
],
"gpu": {"type": "nvidia-tesla-v100",
"count": 1
},
"subnets": [{"region": "us-west1",
"subnetNames": ["private"
]
}
]
},
"scaling": {"up": [{"policyName": "scale_up_1",
"source": "stackdriver",
"metricName": "instance/disk/read_ops_count",
"statistic": "average",
"unit": "percent",
"threshold": 10000,
"namespace": "compute",
"period": 300,
"evaluationPeriods": 1,
"cooldown": 300,
"operator": "gte",
"dimensions": [{"name": "storage_type",
"value": "pd-standard"
}
],
"action": {"type": "adjustment",
"adjustment": 1
}
}
],
"down": [{"policyName": "scale_down_1",
"source": "stackdriver",
"metricName": "instance/disk/read_ops_count",
"statistic": "average",
"unit": "percent",
"threshold": 10000,
"namespace": "compute",
"period": 300,
"evaluationPeriods": 1,
"cooldown": 300,
"operator": "lte",
"dimensions": [{"name": "storage_type",
"value": "pd-standard"
}
],
"action": {"type": "adjustment",
"adjustment": 1
}
}
]
},
"thirdPartiesIntegration": {"dockerSwarm": {"masterHost": "swarm1.swarm.com",
"masterPort": 1234
},
"gke": {"autoUpdate": true,
"autoScale": {"isEnabled": true,
"isAutoConfig": false,
"cooldown": 300,
"headroom": {"cpuPerUnit": 1,
"memoryPerUnit": 0,
"numOfUnits": 1
},
"down": {"evaluationPeriods": 5
}
},
"clusterIdentifier": "gke-clust-1",
"location": "us-west1"
}
},
"createdAt": "2020-10-16T09:03:23.000Z",
"updatedAt": "2020-10-16T09:03:23.000Z"
}
}
],
"count": 1,
"kind": "spotinst:gcp:gce:importGke"
}
}

Get Elastigroup Status

Get the status for all instances that are memebers of the Elastigroup

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

Elastigroup ID

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"privateIpAddress": "string",
"machineType": "string",
"zone": "string",
"instanceName": "string",
"lifeCycle": "string",
"provisioningModel": "string",
"statusName": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"count": 1,
"kind": "spotinst:gcp:gce:group:status"
}
}

List Activity Events

Get all activity events for the Elastigroup

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

Elastigroup ID

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
fromDate required	string <date-time> Example: fromDate=2019-05-17 Get items on or after this date (ISO 8601)
toDate required	string <date-time> Example: toDate=2019-05-25 Get items on or before this date (ISO 8601)

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"groudId": "sig-576g654",
"eventType": "RollFinished",
"createdAt": "2018-03-01T09:58:16.000+0000",
"subEvents": [{"id": "sbgd-1234567",
"groupId": "sig-576g654",
"currentBatch": 1,
"numOfBatches": 1,
"gracePeriod": 300,
"type": "rollInfo",
"status": null,
"createdAt": "2018-03-01T09:58:16.000+0000"
}
]
}
],
"count": 1,
"kind": "spotinst:gcp:gce:group:event"
}
}

Get Elastilog

Fetch a group's Elastilog

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

Elastigroup ID

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
required	unix (string) or dateTime (string) Example: fromDate=2020-09-01 or fromDate=1598918400000 Get items on or after this date (ISO 8601 or Unix timestamp)
limit	integer <= 1000 Default: 500 Example: limit=200 Maximum number of items to return.
required	unix (string) or dateTime (string) Example: toDate=2020-09-01 or toDate=1598918400000 Get items on or before this date (ISO 8601 or Unix timestamp)

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"message": "Group sig-e0a2bd7c successfully created.",
"severity": "INFO",
"createdAt": "2019-05-19T14:34:15.000Z"
}
],
"count": 1,
"kind": "spotinst:gcp:gce:group:log"
}
}

Scale Up

Add instances to the Elastigroup

Authorizations:

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
adjustment required	integer Example: adjustment=1 The number of instances to add to the group

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"newPreemptibles": [{"instanceName": "sin-9da52709"
}
],
"newInstances": [{"instanceName": "sin-1591c0b6"
}
]
}
],
"count": 1,
"kind": "spotinst:gcp:gce:preemptible"
}
}

Scale Down

Remove instances from the Elastigroup

Authorizations:

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
adjustment required	integer Example: adjustment=1 The number of instances to remove from the group

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"victimPreemptibles": [{"instanceName": "sin-4ecd5037",
"zone": "asia-east1-b",
"machineType": "N1_STANDARD_2"
}
],
"victimInstances": [{"instanceName": "sin-31e0596a",
"zone": "europe-west1-c",
"machineType": "N1_STANDARD_1"
}
]
}
],
"count": 1,
"kind": "spotinst:gcp:gce:scale"
}
}

Get Elastigroup Costs

Get financial information on a specific Elastigroup

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

Elastigroup ID

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
required	unix (string) or dateTime (string) Example: fromDate=2020-09-01 or fromDate=1598918400000 Get items on or after this date (ISO 8601 or Unix timestamp)
required	unix (string) or dateTime (string) Example: toDate=2020-09-01 or toDate=1598918400000 Get items on or before this date (ISO 8601 or Unix timestamp)

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"running": {"value": 294.3,
"unit": "hours"
},
"savings": {"value": 60.5263,
"unit": "percentage"
},
"costs": {"actual": 8.829,
"potential": 22.3668
}
}
],
"count": 1,
"kind": "spotinst:gcp:gce:group:costs"
}
}

List Deployments

Get all of the deployments for a specific Elastigroup, and their status

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

Elastigroup ID

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

batchSizePercentage required	integer (in percentage) the batch size of the deployment, i.e.: how many instances to replace in each batch
gracePeriod required	integer (in seconds) the time until an instance becomes healthy in the load balancer

Responses

Request samples

Payload

Content type

application/json

{"batchSizePercentage": 20,
"gracePeriod": 300
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "sbgd-01f01234",
"status": "STARTING",
"currentBatch": 1,
"numOfBatches": 2,
"progress": {"unit": "percentage",
"value": 0
},
"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-11-01T10:50:29.000+0000"
}
],
"count": 1,
"kind": "spotinst:gcp:gce:group:roll"
}
}

Start Deployment

Deploy the Elastigroup: Triggers a Blue/Green deployment that replaces the existing instances in the Elastigroup

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

Elastigroup ID

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

batchSizePercentage required	integer (in percentage) the batch size of the deployment, i.e.: how many instances to replace in each batch
gracePeriod required	integer (in seconds) the time until an instance becomes healthy in the load balancer

Responses

Request samples

Payload

Content type

application/json

{"batchSizePercentage": 20,
"gracePeriod": 300
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "sbgd-01f01234",
"status": "STARTING",
"currentBatch": 1,
"numOfBatches": 2,
"progress": {"unit": "percentage",
"value": 0
}
}
],
"count": 1,
"kind": "spotinst:gcp:gce:group:roll"
}
}

Get Deployment

Get a specific deployment's status

Authorizations:

path Parameters

rollId

required

string

The deployment ID to query

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "sbgd-01f01234",
"status": "STARTING",
"currentBatch": 1,
"numOfBatches": 2,
"progress": {"unit": "percentage",
"value": 0
},
"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-11-01T10:50:29.000+0000"
}
],
"count": 1,
"kind": "spotinst:gcp:gce:group:roll"
}
}

Stop Deployment

Stop an existing deployment

Authorizations:

path Parameters

rollId

required

string

The deployment ID to query

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

object

status

string

in this case, always set to "STOPPED"

Responses

Request samples

Payload

Content type

application/json

{"roll": {"status": "STOPPED"
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "sbgd-01f01234",
"status": "STARTING",
"currentBatch": 1,
"numOfBatches": 2,
"progress": {"unit": "percentage",
"value": 0
}
}
],
"count": 1,
"kind": "spotinst:gcp:gce:group:roll"
}
}

Detach Instances

Detach instances from an Elastigroup

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

Elastigroup ID

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

drainingTimeout	integer (Applies only if shouldTerminateInstances is on) The draining timeout (in seconds) before terminating the instance. If no draining timeout is defined, the group's draining timeout applies.
instancesToDetach	array The names of the instances to detach from the group.
shouldDecrementTargetCapacity	boolean Indicates whether to decrement the capacity of the group, so no new instance will be launched instead of the detached one.
shouldTerminateInstances	boolean Indicates whether to terminate the instances or not.

Responses

Request samples

Payload

Content type

application/json

{"instancesToDetach": ["sin-44c02836",
"sin-ddf71dfa"
],
"shouldTerminateInstances": true,
"shouldDecrementTargetCapacity": true,
"drainingTimeout": 0
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:gcp:gce:detachInstances"
}
}

Get Instance Status

Get the current instance status. Possible status values: ACTIVE, TERMINATING

Authorizations:

path Parameters

instanceId

required

string

GCP Instance ID

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"instanceName": "sin-123",
"lifeCycleState": "ACTIVE",
"privateIp": "10.0.0.1",
"groupId": "sig-123"
}
],
"count": 1,
"kind": "spotinst:gcp:gce:instance"
}
}

Lock Instance

Set termination protection for a specific instance.

Authorizations:

path Parameters

instanceId

required

string

GCP Instance ID

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
ttlInMinutes required	string Specify a TTL (in minutes) for this lock, i.e.: for how long the protection will be valid for.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Unlock Instance

Remove termination protection for a specific instance.

Authorizations:

path Parameters

instanceId

required

string

GCP Instance ID

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Elastigroup Azure Spot VMs

Elastigroup for Microsoft Azure

Update Elastigroup

Update an Azure Elastigroup cluster.

Authorizations:

path Parameters

groupId

required

string

Example: sig-123123

Elastigroup's ID

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

required

object

	object (Capacity) Capacity of Elastigroup.
	object (Elastigroup Compute Update) Compute settings for Elastigroup.
description	string Describe your Azure Elastigroup
	object (Elastigroup Health) Autohealing of unhealthy VMs.
name	string Azure Elastigroup Name
	object (Elastigroup Scaling) Scaling Policies for Elastigroup.
	object (Elastigroup Strategy) Strategy for Elastigroup.

Responses

Request samples

Payload

Content type

application/json

{"group": {"name": "spotinst-group",
"description": "This is my example elastigroup",
"capacity": {"target": 8,
"minimum": 2,
"maximum": 10
},
"strategy": {"spotPercentage": 50,
"onDemandCount": 0,
"drainingTimeout": 30,
"fallbackToOd": true,
"revertToSpot": {"performAt": "timeWindow"
},
"optimizationWindows": ["Mon:03:00-Wed:02:30"
],
"signals": [{"type": "vmReady",
"timeout": 180
}
]
},
"scaling": {"up": [{"policyName": "cpuScaleUp",
"metricName": "Percentage CPU",
"statistic": "Average",
"unit": "percent",
"threshold": 0.75,
"namespace": "Microsoft.Network/applicationGateways",
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"dimenstions": [{"name": "resourceName",
"value": "testApplicationGateway"
},
{"name": "resourceGroupName",
"value": "testResourceGroup"
}
],
"operator": "gte",
"action": {"type": "adjustment",
"adjustment": "2",
"target": 0,
"minimum": 0,
"maximum": 0
}
}
],
"down": [{"policyName": "cpuScaleDown",
"metricName": "Percentage CPU",
"statistic": "Average",
"unit": "percent",
"threshold": 0.25,
"namespace": "Microsoft.Network/applicationGateways",
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"dimenstions": [{"name": "resourceName",
"value": "testApplicationGateway"
},
{"name": "resourceGroupName",
"value": "testResourceGroup"
}
],
"operator": "lte",
"action": {"type": "adjustment",
"adjustment": "2",
"target": 0,
"minimum": 0,
"maximum": 0
}
}
]
},
"compute": {"vmSizes": {"odSizes": ["standard_a1_v1"
],
"spotSizes": ["standard_a2_v2"
],
"preferredSpotSizes": ["standard_a2_v2"
]
},
"launchSpecification": {"vmNamePrefix": "prefix",
"customData": "",
"image": {"marketplace": {"publisher": "OpenLogic",
"offer": "CentOS",
"sku": "7.3",
"version": "7.3-1611"
},
"custom": {"resourceGroupName": "spotinst-azure",
"name": "custom-image-name"
},
"gallery": {"resourceGroupName": "spotinst-azure",
"galleryName": "gallery-name",
"imageName": "gallery-image-name",
"version": "0.0.1"
}
},
"network": {"resourceGroupName": "subnetResourceGroup",
"virtualNetworkName": "vname",
"networkInterfaces": [{"isPrimary": true,
"subnetName": "testSubnet",
"assignPublicIp": true,
"publicIpSku": "STANDARD",
"securityGroup": {"name": "test",
"resourceGroupName": "test"
},
"publicIps": [{"resourceGroupName": "resourceGroup",
"name": "name"
}
],
"enableIPForwarding": true,
"additionalIpConfigurations": [{"name": "test",
"privateIpAddressVersion": "IPv4"
}
],
"applicationSecurityGroups": [{"resourceGroupName": "AsgResourceGroup",
"name": "AsgName"
}
]
}
]
},
"login": {"userName": "spotinst",
"sshPublicKey": "ssh-rsa",
"password": "string"
},
"loadBalancersConfig": {"loadBalancers": [{"type": "loadBalancer",
"resourceGroupName": "testResourceGroup",
"name": "testLoadBalancer",
"sku": "Standard",
"backendPoolNames": ["testBackendPool1",
"testBackendPool2"
]
}
]
},
"managedServiceIdentities": [{"name": "mySI2",
"resourceGroupName": "myResourceGroup"
}
],
"shutdownScript": "IyEvdXNyL2Jpbi9lbnYgYmFzaAoiR29vZGJ5ZSBvbGQgaW5zdGFuY2Ui",
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"extensions": [{"name": "extensionName",
"type": "customScript",
"publisher": "MMicrosoft.Azure.Extensions",
"apiVersion": "2.0",
"minorVersionAutoUpgrade": true,
"publicSettings": { },
"protectedSettings": { }
}
],
"dataDisks": [{"sizeGB": 1,
"lun": 1,
"type": "Standard_LRS"
}
],
"osDisk": {"type": "Standard_LRS",
"sizeGB": 30
},
"bootDiagnostics": {"isEnabled": true,
"type": "unmanaged",
"storageUri": "https://example.blob.core.windows.net/"
},
"secrets": [{"sourceVault": {"resourceGroupName": "string",
"name": "string"
},
"vaultCertificates": [{"certificateUrl": "string",
"certificateStore": "string"
}
]
}
]
},
"zones": [1
],
"preferredZones": [1
]
},
"health": {"healthCheckTypes": ["vmState"
],
"gracePeriod": 120,
"autoHealing": true,
"unhealthyDuration": 360
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/azure/compute/group/sig-12345",
"method": "PUT",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "sig-123456789",
"name": "spotinst-group",
"description": "This is my example elastigroup",
"region": "westus2",
"resourceGroupName": "spotinst-azure",
"capacity": {"target": 8,
"minimum": 2,
"maximum": 10
},
"strategy": {"spotPercentage": 50,
"drainingTimeout": 30,
"fallbackToOd": true,
"revertToSpot": {"performAt": "timeWindow"
},
"optimizationWindows": ["Mon:03:00-Wed:02:30"
],
"signals": [{"type": "vmReady",
"timeout": 180
}
]
},
"scaling": {"up": [{"policyName": "cpuScaleUp",
"metricName": "Percentage CPU",
"statistic": "Average",
"unit": "percent",
"threshold": 0.75,
"namespace": "Microsoft.Network/applicationGateways",
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"dimenstions": [{"name": "resourceName",
"value": "testApplicationGateway"
},
{"name": "resourceGroupName",
"value": "testResourceGroup"
}
],
"operator": "gte",
"action": {"type": "adjustment",
"adjustment": "2",
"target": 0,
"minimum": 0,
"maximum": 0
}
}
],
"down": [{"policyName": "cpuScaleDown",
"metricName": "Percentage CPU",
"statistic": "Average",
"unit": "percent",
"threshold": 0.25,
"namespace": "Microsoft.Network/applicationGateways",
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"dimenstions": [{"name": "resourceName",
"value": "testApplicationGateway"
},
{"name": "resourceGroupName",
"value": "testResourceGroup"
}
],
"operator": "lte",
"action": {"type": "adjustment",
"adjustment": "2",
"target": 0,
"minimum": 0,
"maximum": 0
}
}
]
},
"compute": {"vmSizes": {"odSizes": ["standard_a1_v1"
],
"spotSizes": ["standard_a2_v2"
],
"preferredSpotSizes": ["standard_a2_v2"
]
},
"os": "Linux",
"launchSpecification": {"vmNamePrefix": "prefix",
"customData": "",
"image": {"marketplace": {"publisher": "OpenLogic",
"offer": "CentOS",
"sku": "7.3",
"version": "7.3-1611"
},
"custom": {"resourceGroupName": "spotinst-azure",
"name": "custom-image-name"
},
"gallery": {"resourceGroupName": "spotinst-azure",
"galleryName": "gallery-name",
"imageName": "gallery-image-name",
"version": "0.0.1"
}
},
"network": {"resourceGroupName": "subnetResourceGroup",
"virtualNetworkName": "vname",
"networkInterfaces": [{"isPrimary": true,
"subnetName": "testSubnet",
"assignPublicIp": true,
"publicIpSku": "STANDARD",
"securityGroup": {"name": "test",
"resourceGroupName": "test"
},
"publicIps": [{"resourceGroupName": "resourceGroup",
"name": "name"
}
],
"enableIPForwarding": true,
"additionalIpConfigurations": [{"name": "test",
"privateIpAddressVersion": "IPv4"
}
],
"privateIpAddresses": [["172.23.4.20"
]
],
"applicationSecurityGroups": [{"resourceGroupName": "AsgResourceGroup",
"name": "AsgName"
}
]
}
]
},
"login": {"userName": "spotinst",
"sshPublicKey": "ssh-rsa"
},
"loadBalancersConfig": {"loadBalancers": [{"type": "loadBalancer",
"resourceGroupName": "testResourceGroup",
"name": "testLoadBalancer",
"sku": "Standard",
"backendPoolNames": ["testBackendPool1",
"testBackendPool2"
]
}
]
},
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"extensions": [{"name": "extensionName",
"type": "customScript",
"publisher": "MMicrosoft.Azure.Extensions",
"apiVersion": "2.0",
"minorVersionAutoUpgrade": true,
"publicSettings": { },
"protectedSettings": { }
}
],
"dataDisks": [{"sizeGB": 1,
"lun": 1,
"type": "Standard_LRS"
}
],
"osDisk": {"type": "Standard_LRS",
"sizeGB": 30
},
"bootDiagnostics": {"isEnabled": true,
"type": "unmanaged",
"storageUri": "https://example.blob.core.windows.net/"
},
"secrets": [{"sourceVault": {"resourceGroupName": "string",
"name": "string"
},
"vaultCertificates": [{"certificateUrl": "string",
"certificateStore": "string"
}
]
}
]
},
"zones": [1
],
"preferredZones": [1
]
},
"health": {"healthCheckTypes": ["vmState"
],
"gracePeriod": 120,
"autoHealing": true,
"unhealthyDuration": 360
},
"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-11-01T10:50:29.000+0000"
}
],
"count": 1,
"kind": "spotinst:azure:compute:group"
}
}

Get Elastigroup

List an Elastigroup cluster.

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

The Spot Elastigroup ID you want to update

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/azure/compute/group/sig-12345",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "sig-123456789",
"name": "spotinst-group",
"description": "This is my example elastigroup",
"region": "westus2",
"resourceGroupName": "spotinst-azure",
"capacity": {"target": 8,
"minimum": 2,
"maximum": 10
},
"strategy": {"spotPercentage": 50,
"drainingTimeout": 30,
"fallbackToOd": true,
"revertToSpot": {"performAt": "timeWindow"
},
"optimizationWindows": ["Mon:03:00-Wed:02:30"
],
"signals": [{"type": "vmReady",
"timeout": 180
}
]
},
"scaling": {"up": [{"policyName": "cpuScaleUp",
"metricName": "Percentage CPU",
"statistic": "Average",
"unit": "percent",
"threshold": 0.75,
"namespace": "Microsoft.Network/applicationGateways",
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"dimenstions": [{"name": "resourceName",
"value": "testApplicationGateway"
},
{"name": "resourceGroupName",
"value": "testResourceGroup"
}
],
"operator": "gte",
"action": {"type": "adjustment",
"adjustment": "2",
"target": 0,
"minimum": 0,
"maximum": 0
}
}
],
"down": [{"policyName": "cpuScaleDown",
"metricName": "Percentage CPU",
"statistic": "Average",
"unit": "percent",
"threshold": 0.25,
"namespace": "Microsoft.Network/applicationGateways",
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"dimenstions": [{"name": "resourceName",
"value": "testApplicationGateway"
},
{"name": "resourceGroupName",
"value": "testResourceGroup"
}
],
"operator": "lte",
"action": {"type": "adjustment",
"adjustment": "2",
"target": 0,
"minimum": 0,
"maximum": 0
}
}
]
},
"compute": {"vmSizes": {"odSizes": ["standard_a1_v1"
],
"spotSizes": ["standard_a2_v2"
],
"preferredSpotSizes": ["standard_a2_v2"
]
},
"os": "Linux",
"launchSpecification": {"vmNamePrefix": "prefix",
"customData": "",
"image": {"marketplace": {"publisher": "OpenLogic",
"offer": "CentOS",
"sku": "7.3",
"version": "7.3-1611"
},
"custom": {"resourceGroupName": "spotinst-azure",
"name": "custom-image-name"
},
"gallery": {"resourceGroupName": "spotinst-azure",
"galleryName": "gallery-name",
"imageName": "gallery-image-name",
"version": "0.0.1"
}
},
"network": {"resourceGroupName": "subnetResourceGroup",
"virtualNetworkName": "vname",
"networkInterfaces": [{"isPrimary": true,
"subnetName": "testSubnet",
"assignPublicIp": true,
"publicIpSku": "STANDARD",
"securityGroup": {"name": "test",
"resourceGroupName": "test"
},
"publicIps": [{"resourceGroupName": "resourceGroup",
"name": "name"
}
],
"enableIPForwarding": true,
"additionalIpConfigurations": [{"name": "test",
"privateIpAddressVersion": "IPv4"
}
],
"privateIpAddresses": [["172.23.4.20"
]
],
"applicationSecurityGroups": [{"resourceGroupName": "AsgResourceGroup",
"name": "AsgName"
}
]
}
]
},
"login": {"userName": "spotinst",
"sshPublicKey": "ssh-rsa"
},
"loadBalancersConfig": {"loadBalancers": [{"type": "loadBalancer",
"resourceGroupName": "testResourceGroup",
"name": "testLoadBalancer",
"sku": "Standard",
"backendPoolNames": ["testBackendPool1",
"testBackendPool2"
]
}
]
},
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"extensions": [{"name": "extensionName",
"type": "customScript",
"publisher": "MMicrosoft.Azure.Extensions",
"apiVersion": "2.0",
"minorVersionAutoUpgrade": true,
"publicSettings": { },
"protectedSettings": { }
}
],
"dataDisks": [{"sizeGB": 1,
"lun": 1,
"type": "Standard_LRS"
}
],
"osDisk": {"type": "Standard_LRS",
"sizeGB": 30
},
"bootDiagnostics": {"isEnabled": true,
"type": "unmanaged",
"storageUri": "https://example.blob.core.windows.net/"
},
"secrets": [{"sourceVault": {"resourceGroupName": "string",
"name": "string"
},
"vaultCertificates": [{"certificateUrl": "string",
"certificateStore": "string"
}
]
}
]
},
"zones": [1
],
"preferredZones": [1
]
},
"health": {"healthCheckTypes": ["vmState"
],
"gracePeriod": 120,
"autoHealing": true,
"unhealthyDuration": 360
},
"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-11-01T10:50:29.000+0000"
}
],
"count": 1,
"kind": "spotinst:azure:compute:group"
}
}

Delete Elastigroup

Delete an Elastigroup cluster.

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

The Spot Elastigroup ID you want to update

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/azure/compute/group/sig-12345",
"method": "DELETE",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Update Capacity

Update the capacity of an Elastigroup

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

The Spot Elastigroup ID you want to update

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

object (Capacity)

Capacity of Elastigroup.

maximum	integer Maximum number of VMs.
minimum	integer Minimum number of VMs.
target	integer Desired number of VMs for Elastigroup to maintain.

Responses

Request samples

Payload

Content type

application/json

{"capacity": {"target": 8,
"minimum": 2,
"maximum": 10
}
}

Response samples

Content type

application/json

{"request": {"id": "3ab3fdf7-3af3-46db-9e63-b88cfdac058c",
"url": "/azure/compute/group/sig-b255ac/capacity?accountId=act-567c21",
"method": "PUT",
"timestamp": "2018-08-20T15:31:12.730Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"target": 8,
"minimum": 2,
"maximum": 10
}
],
"count": 1,
"kind": "spotinst:azure:compute:group:capacity"
}
}

Create Elastigroup

Create a new Elastigroup cluster.

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

required

object (Azure Elastigroup)

Azure Elastigroup Configuration

required	object Capacity of Elastigroup
required	object (Compute) Elastigroup's Compute Configurtion
description	string Describe your Azure Elastigroup
	object (Health) Autohealing of unhealthy VMs.
name required	string Azure Elastigroup Name
region required	string Valid Azure region the Elastigroup is managed in
resourceGroupName required	string The Azure resource group to associate the Elastigroup with
	object (Azure Scaling) Scaling Policies for Elastigroup. Set as many policies as needed to maximize the Elastigroup’s efficiency.
required	object (Scaling Strategy)

Responses

Request samples

Payload

Content type

application/json

{"group": {"name": "spotinst-group",
"description": "This is my example elastigroup",
"region": "eastus",
"resourceGroupName": "spotinst-azure",
"capacity": {"target": 8,
"minimum": 2,
"maximum": 10
},
"scaling": {"up": {"policyName": "cpuScale",
"metricName": "Percentage CPU",
"statistic": "average",
"unit": "Count",
"threshold": 0.75,
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"namespace": "Microsoft.Network/applicationGateways",
"operator": "gte",
"dimenstions": [{"key": "resourceGroupName",
"value": "TestAppGateway"
}
],
"action": {"type": "adjustment",
"adjustment": "2",
"target": 23,
"minimum": 20,
"maximum": 25
}
},
"down": {"policyName": "cpuScale",
"metricName": "Percentage CPU",
"statistic": "average",
"unit": "Count",
"threshold": 0.75,
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"namespace": "Microsoft.Network/applicationGateways",
"operator": "gte",
"dimenstions": [{"key": "resourceGroupName",
"value": "TestAppGateway"
}
],
"action": {"type": "adjustment",
"target": 1,
"minimum": 1,
"maximum": 1,
"adjustment": "2"
}
}
},
"strategy": {"spotPercentage": 100,
"onDemandCount": 3,
"drainingTimeout": 120,
"revertToSpot": {"performAt": "always"
},
"optimizationWindows": [ ],
"signals": [{"timeout": 50,
"type": "vmReady"
}
]
},
"health": {"autoHealing": false,
"healthCheckTypes": "vmState",
"gracePeriod": 300,
"unhealthyDuration": 360
},
"compute": {"vmSizes": {"odSizes": ["standard_b1s"
],
"spotSizes": ["standard_a1_v2"
],
"preferredSpotSizes": ["standard_a2_v2"
]
},
"os": "Linux",
"launchSpecification": {"image": {"marketplace": {"publisher": "OpenLogic",
"offer": "CentOS",
"sku": "7.3",
"version": "7.3-1611"
},
"custom": {"resourceGroupName": "spotinst-azure",
"name": "custom-image-name"
},
"gallery": {"resourceGroupName": "spotinst-azure",
"galleryName": "gallery-name",
"imageName": "gallery-image-name",
"version": "0.0.1"
}
},
"loadBalancersConfig": {"loadBalancers": [{"type": "MULTAI_TARGET_SET",
"balancerId": "lb-1ee2e3q",
"targetSetId": "ts-3eq",
"autoWeight": true
}
]
},
"managedServiceIdentities": [{"resourceGroupName": "Resourse Group 1",
"name": "Test"
}
],
"shutdownScript": "IyEvYmluL2Jhc2gKZWNobyAidGVzdCI=",
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"network": {"resourceGroupName": "subnetResourceGroup",
"virtualNetworkName": "vname",
"networkInterfaces": [{"isPrimary": true,
"subnetName": "testSubnet",
"assignPublicIp": true,
"publicIpSku": "STANDARD",
"securityGroup": {"name": "test",
"resourceGroupName": "test"
},
"publicIps": [{"resourceGroupName": "resourceGroup",
"name": "name"
}
],
"enableIPForwarding": true,
"additionalIpConfigurations": [{"name": "test",
"privateIpAddressVersion": "IPv4"
}
],
"privateIpAddresses": [["172.232.5.3",
"172.23.5.4",
"172.23.5.7",
"172.23.5.8",
"172.23.5.9",
"172.23.5.10"
]
],
"applicationSecurityGroups": [{"resourceGroupName": "AsgResourceGroup",
"name": "AsgName"
}
]
}
]
},
"extensions": [{"autoUpgradeMinorVersion": true,
"name": "k8s-agentpool1-38611891-vmss-computeAksLinuxBilling",
"protectedSettings": {"commandToExecute": "string"
},
"publicSettings": { },
"publisher": "Microsoft.AKS",
"type": "Compute.AKS-Engine.Linux.Billing",
"apiVersion": 1,
"minorVersionAutoUpgrade": true
}
],
"dataDisks": [{"type": "Standard_LRS",
"lun": 6,
"sizeGB": 10
}
],
"osDisk": {"type": "Standard_LRS",
"size": 6
},
"vmNamePrefix": "prefix",
"customData": "IyEvYmluL2Jhc2gKZWNobyAidGVzdCI=",
"login": {"userName": "spotinst",
"sshPublicKey": "string",
"password": "string"
},
"bootDiagnostics": {"isEnabled": true,
"type": "unmanaged",
"storageUri": "https://example.blob.core.windows.net/"
},
"secrets": [{"sourceVault": {"resourceGroupName": "string",
"name": "string"
},
"vaultCertificates": [{"certificateUrl": "string",
"certificateStore": "string"
}
]
}
]
},
"zones": [1
],
"preferredZones": [1
]
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/azure/compute/group",
"method": "POST",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "sig-123456789",
"name": "spotinst-group",
"description": "This is my example elastigroup",
"region": "westus2",
"resourceGroupName": "spotinst-azure",
"capacity": {"target": 8,
"minimum": 2,
"maximum": 10
},
"strategy": {"spotPercentage": 50,
"drainingTimeout": 30,
"fallbackToOd": true,
"revertToSpot": {"performAt": "timeWindow"
},
"optimizationWindows": ["Mon:03:00-Wed:02:30"
],
"signals": [{"type": "vmReady",
"timeout": 180
}
]
},
"scaling": {"up": [{"policyName": "cpuScaleUp",
"metricName": "Percentage CPU",
"statistic": "Average",
"unit": "percent",
"threshold": 0.75,
"namespace": "Microsoft.Network/applicationGateways",
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"dimenstions": [{"name": "resourceName",
"value": "testApplicationGateway"
},
{"name": "resourceGroupName",
"value": "testResourceGroup"
}
],
"operator": "gte",
"action": {"type": "adjustment",
"adjustment": "2",
"target": 0,
"minimum": 0,
"maximum": 0
}
}
],
"down": [{"policyName": "cpuScaleDown",
"metricName": "Percentage CPU",
"statistic": "Average",
"unit": "percent",
"threshold": 0.25,
"namespace": "Microsoft.Network/applicationGateways",
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"dimenstions": [{"name": "resourceName",
"value": "testApplicationGateway"
},
{"name": "resourceGroupName",
"value": "testResourceGroup"
}
],
"operator": "lte",
"action": {"type": "adjustment",
"adjustment": "2",
"target": 0,
"minimum": 0,
"maximum": 0
}
}
]
},
"compute": {"vmSizes": {"odSizes": ["standard_a1_v1"
],
"spotSizes": ["standard_a2_v2"
],
"preferredSpotSizes": ["standard_a2_v2"
]
},
"os": "Linux",
"launchSpecification": {"vmNamePrefix": "prefix",
"customData": "",
"image": {"marketplace": {"publisher": "OpenLogic",
"offer": "CentOS",
"sku": "7.3",
"version": "7.3-1611"
},
"custom": {"resourceGroupName": "spotinst-azure",
"name": "custom-image-name"
},
"gallery": {"resourceGroupName": "spotinst-azure",
"galleryName": "gallery-name",
"imageName": "gallery-image-name",
"version": "0.0.1"
}
},
"network": {"resourceGroupName": "subnetResourceGroup",
"virtualNetworkName": "vname",
"networkInterfaces": [{"isPrimary": true,
"subnetName": "testSubnet",
"assignPublicIp": true,
"publicIpSku": "STANDARD",
"securityGroup": {"name": "test",
"resourceGroupName": "test"
},
"publicIps": [{"resourceGroupName": "resourceGroup",
"name": "name"
}
],
"enableIPForwarding": true,
"additionalIpConfigurations": [{"name": "test",
"privateIpAddressVersion": "IPv4"
}
],
"privateIpAddresses": [["172.23.4.20"
]
],
"applicationSecurityGroups": [{"resourceGroupName": "AsgResourceGroup",
"name": "AsgName"
}
]
}
]
},
"login": {"userName": "spotinst",
"sshPublicKey": "ssh-rsa"
},
"loadBalancersConfig": {"loadBalancers": [{"type": "loadBalancer",
"resourceGroupName": "testResourceGroup",
"name": "testLoadBalancer",
"sku": "Standard",
"backendPoolNames": ["testBackendPool1",
"testBackendPool2"
]
}
]
},
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"extensions": [{"name": "extensionName",
"type": "customScript",
"publisher": "MMicrosoft.Azure.Extensions",
"apiVersion": "2.0",
"minorVersionAutoUpgrade": true,
"publicSettings": { },
"protectedSettings": { }
}
],
"dataDisks": [{"sizeGB": 1,
"lun": 1,
"type": "Standard_LRS"
}
],
"osDisk": {"type": "Standard_LRS",
"sizeGB": 30
},
"bootDiagnostics": {"isEnabled": true,
"type": "unmanaged",
"storageUri": "https://example.blob.core.windows.net/"
},
"secrets": [{"sourceVault": {"resourceGroupName": "string",
"name": "string"
},
"vaultCertificates": [{"certificateUrl": "string",
"certificateStore": "string"
}
]
}
]
},
"zones": [1
],
"preferredZones": [1
]
},
"health": {"healthCheckTypes": ["vmState"
],
"gracePeriod": 120,
"autoHealing": true,
"unhealthyDuration": 360
},
"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-11-01T10:50:29.000+0000"
}
],
"count": 1,
"kind": "spotinst:azure:compute:group"
}
}

List Elastigroups

List Elastigroup clusters.

Authorizations:

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
NAME	string Example: NAME=name Filters to find the Elastigroup via a specific name.
REGION	string Example: REGION=region Filters to find all the groups in a specific region.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/azure/compute/group",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "sig-123456789",
"name": "spotinst-group",
"description": "This is my example elastigroup",
"region": "westus2",
"resourceGroupName": "spotinst-azure",
"capacity": {"target": 8,
"minimum": 2,
"maximum": 10
},
"strategy": {"spotPercentage": 50,
"drainingTimeout": 30,
"fallbackToOd": true,
"revertToSpot": {"performAt": "timeWindow"
},
"optimizationWindows": ["Mon:03:00-Wed:02:30"
],
"signals": [{"type": "vmReady",
"timeout": 180
}
]
},
"scaling": {"up": [{"policyName": "cpuScaleUp",
"metricName": "Percentage CPU",
"statistic": "Average",
"unit": "percent",
"threshold": 0.75,
"namespace": "Microsoft.Network/applicationGateways",
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"dimenstions": [{"name": "resourceName",
"value": "testApplicationGateway"
},
{"name": "resourceGroupName",
"value": "testResourceGroup"
}
],
"operator": "gte",
"action": {"type": "adjustment",
"adjustment": "2",
"target": 0,
"minimum": 0,
"maximum": 0
}
}
],
"down": [{"policyName": "cpuScaleDown",
"metricName": "Percentage CPU",
"statistic": "Average",
"unit": "percent",
"threshold": 0.25,
"namespace": "Microsoft.Network/applicationGateways",
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"dimenstions": [{"name": "resourceName",
"value": "testApplicationGateway"
},
{"name": "resourceGroupName",
"value": "testResourceGroup"
}
],
"operator": "lte",
"action": {"type": "adjustment",
"adjustment": "2",
"target": 0,
"minimum": 0,
"maximum": 0
}
}
]
},
"compute": {"vmSizes": {"odSizes": ["standard_a1_v1"
],
"spotSizes": ["standard_a2_v2"
],
"preferredSpotSizes": ["standard_a2_v2"
]
},
"os": "Linux",
"launchSpecification": {"vmNamePrefix": "prefix",
"customData": "",
"image": {"marketplace": {"publisher": "OpenLogic",
"offer": "CentOS",
"sku": "7.3",
"version": "7.3-1611"
},
"custom": {"resourceGroupName": "spotinst-azure",
"name": "custom-image-name"
},
"gallery": {"resourceGroupName": "spotinst-azure",
"galleryName": "gallery-name",
"imageName": "gallery-image-name",
"version": "0.0.1"
}
},
"network": {"resourceGroupName": "subnetResourceGroup",
"virtualNetworkName": "vname",
"networkInterfaces": [{"isPrimary": true,
"subnetName": "testSubnet",
"assignPublicIp": true,
"publicIpSku": "STANDARD",
"securityGroup": {"name": "test",
"resourceGroupName": "test"
},
"publicIps": [{"resourceGroupName": "resourceGroup",
"name": "name"
}
],
"enableIPForwarding": true,
"additionalIpConfigurations": [{"name": "test",
"privateIpAddressVersion": "IPv4"
}
],
"privateIpAddresses": [["172.23.4.20"
]
],
"applicationSecurityGroups": [{"resourceGroupName": "AsgResourceGroup",
"name": "AsgName"
}
]
}
]
},
"login": {"userName": "spotinst",
"sshPublicKey": "ssh-rsa"
},
"loadBalancersConfig": {"loadBalancers": [{"type": "loadBalancer",
"resourceGroupName": "testResourceGroup",
"name": "testLoadBalancer",
"sku": "Standard",
"backendPoolNames": ["testBackendPool1",
"testBackendPool2"
]
}
]
},
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"extensions": [{"name": "extensionName",
"type": "customScript",
"publisher": "MMicrosoft.Azure.Extensions",
"apiVersion": "2.0",
"minorVersionAutoUpgrade": true,
"publicSettings": { },
"protectedSettings": { }
}
],
"dataDisks": [{"sizeGB": 1,
"lun": 1,
"type": "Standard_LRS"
}
],
"osDisk": {"type": "Standard_LRS",
"sizeGB": 30
},
"bootDiagnostics": {"isEnabled": true,
"type": "unmanaged",
"storageUri": "https://example.blob.core.windows.net/"
},
"secrets": [{"sourceVault": {"resourceGroupName": "string",
"name": "string"
},
"vaultCertificates": [{"certificateUrl": "string",
"certificateStore": "string"
}
]
}
]
},
"zones": [1
],
"preferredZones": [1
]
},
"health": {"healthCheckTypes": ["vmState"
],
"gracePeriod": 120,
"autoHealing": true,
"unhealthyDuration": 360
},
"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-11-01T10:50:29.000+0000"
}
],
"count": 1,
"kind": "spotinst:azure:compute:group"
}
}

Get Elastigroup Status

Get status of Elastigroup cluster.

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

The Spot Elastigroup ID you want to update

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"status": "ready",
"vms": [{"vmName": "vm-12345",
"region": "eastus",
"vmSize": "standard_a1_v2",
"lifeCycle": "spot",
"os": "Linux",
"privateIp": "192.0.0.1",
"publicIp": "183.123.67.79",
"provisioningState": "succeeded",
"powerState": "running",
"createdAt": "2020-06-18T12:02:49.000Z"
}
],
"suspendedProcesses": [{"name": "autoHealing",
"expiresAt": "2020-11-10T18:43:52.000Z"
},
{"name": "signalTimeout"
},
{"name": "autoScale"
},
{"name": "scaleDown"
},
{"name": "syncStrategy",
"expiresAt": "2020-11-10T17:43:52.000Z"
}
]
}
],
"count": 1,
"kind": "spotinst:azure:compute:group:status"
}
}

Vm Healthiness

Get a list of vms with health status.

Authorizations:

path Parameters

groupId

required

string

Example: sig-123123

Elastigroup's ID

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/azure/compute/group/sig-123123/vmHealthiness",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"vmName": "vm-123456789",
"lifeCycle": "SPOT",
"healthStatus": "HEALTHY"
}
],
"count": 1,
"kind": "spotinst:azure:compute:group:vmHealthiness"
}
}

Suspend Group

Suspends the Group.

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

The Spot Elastigroup ID you want to update

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

required

Array of objects[ items ]

List of processes to create or update their suspensions

Array

name required	string Enum: "autoHealing" "signalTimeout" "autoScale" "scaleDown" "syncStrategy" "preventiveReplacement" Process name to create signal timeout
ttlInMinutes	integer >= 0 The duration in minutes which the process is suspended for; if not provided, then it will remain suspended until resumed

Responses

Request samples

Payload

Content type

application/json

{"processes": [{"name": "autoHealing",
"ttlInMinute": 120
},
{"name": "signalTimeout"
}
]
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/azure/compute/group/sig-12345/suspend?accountId=act-123456789",
"method": "PUT",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Resume Group

Resumes the Group.

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

The Spot Elastigroup ID you want to update

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

required

Array of objects[ items ]

List of processes to cancel their suspensions

Array

name

required

string

Enum: "autoHealing" "signalTimeout" "autoScale" "scaleDown" "syncStrategy" "preventiveReplacement"

Process name to create signal timeout

Responses

Request samples

Payload

Content type

application/json

{"processes": [{"name": "syncStrategy"
},
{"name": "signalTimeout"
}
]
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/azure/compute/group/sig-12345/resume?accountId=act-123456789",
"method": "PUT",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Detach VMs

Scale down specific virtual machines in Elastigroup cluster.

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

The Spot Elastigroup ID you want to update

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

drainingTimeout	string Default: 300 The time in seconds to allow the virtual machine be be drained from incoming TCP connections and detached from MLB before terminating it.
shouldDecrementTargetCapacity required	boolean Prevent Elastigroup from scaling back to target capacity when virtual machines are detached.
shouldTerminateVms required	boolean Whether to terminate the VMs or not.
vmsToDetach required	Array of strings Array of virtual machine names to detach.

Responses

Request samples

Payload

Content type

application/json

{"vmsToDetach": ["vm-0fbd69f960db"
],
"shouldTerminateVms": true,
"shouldDecrementTargetCapacity": true,
"drainingTimeout": 300
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"detachedVms": [{"vmName": "vm-12345",
"region": "eastus",
"vmSize": "standard_a1_v2",
"lifeCycle": "spot",
"os": "Linux",
"privateIp": "192.0.0.1",
"publicIp": "183.123.67.79"
}
],
"newVms": [{"vmName": "vm-56789",
"region": "eastus",
"vmSize": "standard_a1_v2",
"lifeCycle": "spot",
"os": "Linux",
"privateIp": "192.0.0.1",
"publicIp": "183.123.67.79",
"provisioningState": "succeeded",
"powerState": "running",
"createdAt": "2020-06-18T12:02:49.000Z"
}
]
}
],
"count": 1,
"kind": "spotinst:azure:compute:group:detachVms"
}
}

Scale Down

Scale down virtual machines in Elastigroup cluster.

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

The Spot Elastigroup ID you want to update

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
adjustment required	integer Example: adjustment=5 Number of VMs to scale down

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"status": "ready",
"vms": [{"vmName": "vm-12345",
"region": "eastus",
"vmSize": "standard_a1_v2",
"lifeCycle": "spot",
"os": "Linux",
"privateIp": "192.0.0.1",
"publicIp": "183.123.67.79",
"provisioningState": "succeeded",
"powerState": "running",
"createdAt": "2020-06-18T12:02:49.000Z"
}
],
"suspendedProcesses": [{"name": "autoHealing",
"expiresAt": "2020-11-10T18:43:52.000Z"
},
{"name": "signalTimeout"
},
{"name": "autoScale"
},
{"name": "scaleDown"
},
{"name": "syncStrategy",
"expiresAt": "2020-11-10T17:43:52.000Z"
}
]
}
],
"count": 1,
"kind": "spotinst:azure:compute:group:status"
}
}

Scale Up

Scale up virtual machines in Elastigroup cluster.

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

The Spot Elastigroup ID you want to update

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
adjustment required	integer Example: adjustment=5 Number of VMs to scale up

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"status": "ready",
"vms": [{"vmName": "vm-12345",
"region": "eastus",
"vmSize": "standard_a1_v2",
"lifeCycle": "spot",
"os": "Linux",
"privateIp": "192.0.0.1",
"publicIp": "183.123.67.79",
"provisioningState": "succeeded",
"powerState": "running",
"createdAt": "2020-06-18T12:02:49.000Z"
}
],
"suspendedProcesses": [{"name": "autoHealing",
"expiresAt": "2020-11-10T18:43:52.000Z"
},
{"name": "signalTimeout"
},
{"name": "autoScale"
},
{"name": "scaleDown"
},
{"name": "syncStrategy",
"expiresAt": "2020-11-10T17:43:52.000Z"
}
]
}
],
"count": 1,
"kind": "spotinst:azure:compute:group:status"
}
}

Start Deployment

Deploy the Elastigroup. This triggers a Blue/Green deployment that replaces the existing VMs in the Elastigroup.

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

The Spot Elastigroup ID you want to update

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

object (groupVmDeployment)

batchMinHealthyPercentage	integer [ 1 .. 100 ] Default: 50 Indicates the threshold of minimum healthy virtual machines in a single batch. If the amount of healthy virtual machines in a single batch is under the threshold, the deployment will fail. The value of the parameter should represent the number in percentage (%) of the batch.
batchSizePercentage	integer [ 1 .. 100 ] Default: 25 Indicates (in percentage) the batch size of the deployment (meaning, how many nodes to replace in each batch). Cannot be null.
drainingTimeout	integer >= 0 Indicates (in seconds) the timeout to drain the instances. Can be null. Default - The Elastigroups draining time out or 120.
gracePeriod	integer >= 300 Default: 600 Indicates (in seconds) the timeout to wait until the node becomes healthy.
healthCheckTypes	array Items Enum: "vmState" "applicationGateway" Define a health check type. Can be null. If no value is set, the deployment will use the group's auto-healing health check.

Responses

Request samples

Payload

Content type

application/json

{"deployment": {"batchSizePercentage": 50,
"gracePeriod": 300,
"batchMinHealthyPercentage": 100,
"drainingTimeout": 120,
"healthCheckTypes": ["vmState"
]
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "sbgd-f331fb8e",
"groupId": "sig-a7aa60cd",
"status": "deploymentStart",
"currentBatch": 1,
"numOfBatches": 2,
"progress": {"unit": "percentage",
"value": 10
},
"updatedAt": "2020-06-22T11:15:06.614Z",
"createdAt": "2020-06-22T11:15:06.614Z"
}
],
"count": 1,
"kind": "spotinst:azure:compute:group:deployment"
}
}

Get All Deployments

Get a list of all the deployments of a specific Elastigroup and the status of each one.

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

The Spot Elastigroup ID you want to update

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
LIMIT	integer Example: LIMIT=14 Limits the number of deployments returned. Default: 5
SORT	string Example: SORT=createdAt:DESC Field by which to sort the results. Default: createdAt:DESC

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "sbgd-f331fb8e",
"groupId": "sig-a7aa60cd",
"status": "deploymentStart",
"currentBatch": 1,
"numOfBatches": 2,
"progress": {"unit": "percentage",
"value": 10
},
"updatedAt": "2020-06-22T11:15:06.614Z",
"createdAt": "2020-06-22T11:15:06.614Z"
}
],
"count": 1,
"kind": "spotinst:azure:compute:group:deployment"
}
}

Get Deployment

Get the status of a specific deployment.

Authorizations:

path Parameters

DEPLOYMENT_ID required	string Example: sbgd-9876 The deployment ID you want to query.
groupId required	string Example: sig-12345 The Spot Elastigroup ID you want to update

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "sbgd-f331fb8e",
"groupId": "sig-a7aa60cd",
"status": "deploymentStart",
"currentBatch": 1,
"numOfBatches": 2,
"progress": {"unit": "percentage",
"value": 10
},
"updatedAt": "2020-06-22T11:15:06.614Z",
"createdAt": "2020-06-22T11:15:06.614Z"
}
],
"count": 1,
"kind": "spotinst:azure:compute:group:deployment"
}
}

Get Deployment Status

Get the detailed status of a specific deployment. This includes status details per batch and other information.

Authorizations:

path Parameters

DEPLOYMENT_ID required	string Example: sbgd-9876 The deployment ID you want to query.
groupId required	string Example: sig-12345 The Spot Elastigroup ID you want to update

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"detailsOverview": {"deploymentId": "sbgd-04c4658b",
"numberOfBatches": 2,
"currentBatch": 2,
"gracePeriod": 2,
"blueVms": 2,
"greenVms": 1,
"description": null,
"errorMessage": null,
"createdAt": "2020-06-18T05:33:18.000Z",
"healthCheck": ["instanceState"
]
},
"batches": [{"batch": 1,
"blue": {"vmName": "i-57ef3cf7a694",
"batchNum": 1,
"status": "detached",
"type": "old",
"updatedAt": "2020-06-18T11:16:58.000Z"
},
"green": {"vmName": "i-f2a44ba41875",
"batchNum": 1,
"status": "detached",
"type": "old",
"updatedAt": "2020-06-18T11:16:58.000Z"
}
}
],
"events": [{"status": "deploymentStart",
"eventType": "Batch 1 - Launching New instances",
"timestamp": "2020-06-18T05:33:18.000Z"
}
]
}
],
"count": 1,
"kind": "spotinst:azure:compute:deployment:details"
}
}

Import Group From Scale Set

Given a scale set, constructs a valid group configuration based on the scale set and returns it.

Authorizations:

path Parameters

resourceGroupName required	string Example: ExampleResourceGroup Resource Group Name - Must be valid.
scaleSetName required	string Example: MyExampleScaleSetImport Scale Set Name - Must be valid

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/azure/compute/group/import/resourceGroup/myResourceGroup/scaleSet/myScaleSet",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "sig-123456789",
"name": "spotinst-group",
"description": "This is my example elastigroup",
"region": "westus2",
"resourceGroupName": "spotinst-azure",
"capacity": {"target": 8,
"minimum": 2,
"maximum": 10
},
"strategy": {"spotPercentage": 50,
"drainingTimeout": 30,
"fallbackToOd": true,
"revertToSpot": {"performAt": "timeWindow"
},
"optimizationWindows": ["Mon:03:00-Wed:02:30"
],
"signals": [{"type": "vmReady",
"timeout": 180
}
]
},
"scaling": {"up": [{"policyName": "cpuScaleUp",
"metricName": "Percentage CPU",
"statistic": "Average",
"unit": "percent",
"threshold": 0.75,
"namespace": "Microsoft.Network/applicationGateways",
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"dimenstions": [{"name": "resourceName",
"value": "testApplicationGateway"
},
{"name": "resourceGroupName",
"value": "testResourceGroup"
}
],
"operator": "gte",
"action": {"type": "adjustment",
"adjustment": "2",
"target": 0,
"minimum": 0,
"maximum": 0
}
}
],
"down": [{"policyName": "cpuScaleDown",
"metricName": "Percentage CPU",
"statistic": "Average",
"unit": "percent",
"threshold": 0.25,
"namespace": "Microsoft.Network/applicationGateways",
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"dimenstions": [{"name": "resourceName",
"value": "testApplicationGateway"
},
{"name": "resourceGroupName",
"value": "testResourceGroup"
}
],
"operator": "lte",
"action": {"type": "adjustment",
"adjustment": "2",
"target": 0,
"minimum": 0,
"maximum": 0
}
}
]
},
"compute": {"vmSizes": {"odSizes": ["standard_a1_v1"
],
"spotSizes": ["standard_a2_v2"
],
"preferredSpotSizes": ["standard_a2_v2"
]
},
"os": "Linux",
"launchSpecification": {"vmNamePrefix": "prefix",
"customData": "",
"image": {"marketplace": {"publisher": "OpenLogic",
"offer": "CentOS",
"sku": "7.3",
"version": "7.3-1611"
},
"custom": {"resourceGroupName": "spotinst-azure",
"name": "custom-image-name"
},
"gallery": {"resourceGroupName": "spotinst-azure",
"galleryName": "gallery-name",
"imageName": "gallery-image-name",
"version": "0.0.1"
}
},
"network": {"resourceGroupName": "subnetResourceGroup",
"virtualNetworkName": "vname",
"networkInterfaces": [{"isPrimary": true,
"subnetName": "testSubnet",
"assignPublicIp": true,
"publicIpSku": "STANDARD",
"securityGroup": {"name": "test",
"resourceGroupName": "test"
},
"publicIps": [{"resourceGroupName": "resourceGroup",
"name": "name"
}
],
"enableIPForwarding": true,
"additionalIpConfigurations": [{"name": "test",
"privateIpAddressVersion": "IPv4"
}
],
"privateIpAddresses": [["172.23.4.20"
]
],
"applicationSecurityGroups": [{"resourceGroupName": "AsgResourceGroup",
"name": "AsgName"
}
]
}
]
},
"login": {"userName": "spotinst",
"sshPublicKey": "ssh-rsa"
},
"loadBalancersConfig": {"loadBalancers": [{"type": "loadBalancer",
"resourceGroupName": "testResourceGroup",
"name": "testLoadBalancer",
"sku": "Standard",
"backendPoolNames": ["testBackendPool1",
"testBackendPool2"
]
}
]
},
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"extensions": [{"name": "extensionName",
"type": "customScript",
"publisher": "MMicrosoft.Azure.Extensions",
"apiVersion": "2.0",
"minorVersionAutoUpgrade": true,
"publicSettings": { },
"protectedSettings": { }
}
],
"dataDisks": [{"sizeGB": 1,
"lun": 1,
"type": "Standard_LRS"
}
],
"osDisk": {"type": "Standard_LRS",
"sizeGB": 30
},
"bootDiagnostics": {"isEnabled": true,
"type": "unmanaged",
"storageUri": "https://example.blob.core.windows.net/"
},
"secrets": [{"sourceVault": {"resourceGroupName": "string",
"name": "string"
},
"vaultCertificates": [{"certificateUrl": "string",
"certificateStore": "string"
}
]
}
]
},
"zones": [1
],
"preferredZones": [1
]
},
"health": {"healthCheckTypes": ["vmState"
],
"gracePeriod": 120,
"autoHealing": true,
"unhealthyDuration": 360
},
"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-11-01T10:50:29.000+0000"
}
],
"count": 1,
"kind": "azure:compute:elastigroup:importScaleSet"
}
}

Import Group From Virtual Machine

Given a virtual machine, constructs a valid group configuration based on the virtual machine and returns it.

Authorizations:

path Parameters

resourceGroupName	string Example: ExampleResourceGroup
virtualMachineName	string Example: MyExampleVirtualMachineImport

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/azure/compute/group/import/resourceGroup/myResourceGroup/scaleSet/myScaleSet",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "sig-123456789",
"name": "spotinst-group",
"description": "This is my example elastigroup",
"region": "westus2",
"resourceGroupName": "spotinst-azure",
"capacity": {"target": 8,
"minimum": 2,
"maximum": 10
},
"strategy": {"spotPercentage": 50,
"drainingTimeout": 30,
"fallbackToOd": true,
"revertToSpot": {"performAt": "timeWindow"
},
"optimizationWindows": ["Mon:03:00-Wed:02:30"
],
"signals": [{"type": "vmReady",
"timeout": 180
}
]
},
"scaling": {"up": [{"policyName": "cpuScaleUp",
"metricName": "Percentage CPU",
"statistic": "Average",
"unit": "percent",
"threshold": 0.75,
"namespace": "Microsoft.Network/applicationGateways",
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"dimenstions": [{"name": "resourceName",
"value": "testApplicationGateway"
},
{"name": "resourceGroupName",
"value": "testResourceGroup"
}
],
"operator": "gte",
"action": {"type": "adjustment",
"adjustment": "2",
"target": 0,
"minimum": 0,
"maximum": 0
}
}
],
"down": [{"policyName": "cpuScaleDown",
"metricName": "Percentage CPU",
"statistic": "Average",
"unit": "percent",
"threshold": 0.25,
"namespace": "Microsoft.Network/applicationGateways",
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"dimenstions": [{"name": "resourceName",
"value": "testApplicationGateway"
},
{"name": "resourceGroupName",
"value": "testResourceGroup"
}
],
"operator": "lte",
"action": {"type": "adjustment",
"adjustment": "2",
"target": 0,
"minimum": 0,
"maximum": 0
}
}
]
},
"compute": {"vmSizes": {"odSizes": ["standard_a1_v1"
],
"spotSizes": ["standard_a2_v2"
],
"preferredSpotSizes": ["standard_a2_v2"
]
},
"os": "Linux",
"launchSpecification": {"vmNamePrefix": "prefix",
"customData": "",
"image": {"marketplace": {"publisher": "OpenLogic",
"offer": "CentOS",
"sku": "7.3",
"version": "7.3-1611"
},
"custom": {"resourceGroupName": "spotinst-azure",
"name": "custom-image-name"
},
"gallery": {"resourceGroupName": "spotinst-azure",
"galleryName": "gallery-name",
"imageName": "gallery-image-name",
"version": "0.0.1"
}
},
"network": {"resourceGroupName": "subnetResourceGroup",
"virtualNetworkName": "vname",
"networkInterfaces": [{"isPrimary": true,
"subnetName": "testSubnet",
"assignPublicIp": true,
"publicIpSku": "STANDARD",
"securityGroup": {"name": "test",
"resourceGroupName": "test"
},
"publicIps": [{"resourceGroupName": "resourceGroup",
"name": "name"
}
],
"enableIPForwarding": true,
"additionalIpConfigurations": [{"name": "test",
"privateIpAddressVersion": "IPv4"
}
],
"privateIpAddresses": [["172.23.4.20"
]
],
"applicationSecurityGroups": [{"resourceGroupName": "AsgResourceGroup",
"name": "AsgName"
}
]
}
]
},
"login": {"userName": "spotinst",
"sshPublicKey": "ssh-rsa"
},
"loadBalancersConfig": {"loadBalancers": [{"type": "loadBalancer",
"resourceGroupName": "testResourceGroup",
"name": "testLoadBalancer",
"sku": "Standard",
"backendPoolNames": ["testBackendPool1",
"testBackendPool2"
]
}
]
},
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"extensions": [{"name": "extensionName",
"type": "customScript",
"publisher": "MMicrosoft.Azure.Extensions",
"apiVersion": "2.0",
"minorVersionAutoUpgrade": true,
"publicSettings": { },
"protectedSettings": { }
}
],
"dataDisks": [{"sizeGB": 1,
"lun": 1,
"type": "Standard_LRS"
}
],
"osDisk": {"type": "Standard_LRS",
"sizeGB": 30
},
"bootDiagnostics": {"isEnabled": true,
"type": "unmanaged",
"storageUri": "https://example.blob.core.windows.net/"
},
"secrets": [{"sourceVault": {"resourceGroupName": "string",
"name": "string"
},
"vaultCertificates": [{"certificateUrl": "string",
"certificateStore": "string"
}
]
}
]
},
"zones": [1
],
"preferredZones": [1
]
},
"health": {"healthCheckTypes": ["vmState"
],
"gracePeriod": 120,
"autoHealing": true,
"unhealthyDuration": 360
},
"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-11-01T10:50:29.000+0000"
}
],
"count": 1,
"kind": "azure:compute:elastigroup:importVirtualMachine"
}
}

Import Group From Load Balancer

Given a load balancer, constructs a valid group configuration and returns it.

Authorizations:

path Parameters

backendPoolName	string Example: MyExampleBackendPoolName
loadBalancerName	string Example: MyExampleLoadBalancerImport
resourceGroupName	string Example: ExampleResourceGroup

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/azure/compute/group/import/resourceGroup/myResourceGroup/loadBalancer/myLoadBalancer/backendPool/myBackendPool",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "sig-123456789",
"name": "spotinst-group",
"description": "This is my example elastigroup",
"region": "westus2",
"resourceGroupName": "spotinst-azure",
"capacity": {"target": 8,
"minimum": 2,
"maximum": 10
},
"strategy": {"spotPercentage": 50,
"drainingTimeout": 30,
"fallbackToOd": true,
"revertToSpot": {"performAt": "timeWindow"
},
"optimizationWindows": ["Mon:03:00-Wed:02:30"
],
"signals": [{"type": "vmReady",
"timeout": 180
}
]
},
"scaling": {"up": [{"policyName": "cpuScaleUp",
"metricName": "Percentage CPU",
"statistic": "Average",
"unit": "percent",
"threshold": 0.75,
"namespace": "Microsoft.Network/applicationGateways",
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"dimenstions": [{"name": "resourceName",
"value": "testApplicationGateway"
},
{"name": "resourceGroupName",
"value": "testResourceGroup"
}
],
"operator": "gte",
"action": {"type": "adjustment",
"adjustment": "2",
"target": 0,
"minimum": 0,
"maximum": 0
}
}
],
"down": [{"policyName": "cpuScaleDown",
"metricName": "Percentage CPU",
"statistic": "Average",
"unit": "percent",
"threshold": 0.25,
"namespace": "Microsoft.Network/applicationGateways",
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"dimenstions": [{"name": "resourceName",
"value": "testApplicationGateway"
},
{"name": "resourceGroupName",
"value": "testResourceGroup"
}
],
"operator": "lte",
"action": {"type": "adjustment",
"adjustment": "2",
"target": 0,
"minimum": 0,
"maximum": 0
}
}
]
},
"compute": {"vmSizes": {"odSizes": ["standard_a1_v1"
],
"spotSizes": ["standard_a2_v2"
],
"preferredSpotSizes": ["standard_a2_v2"
]
},
"os": "Linux",
"launchSpecification": {"vmNamePrefix": "prefix",
"customData": "",
"image": {"marketplace": {"publisher": "OpenLogic",
"offer": "CentOS",
"sku": "7.3",
"version": "7.3-1611"
},
"custom": {"resourceGroupName": "spotinst-azure",
"name": "custom-image-name"
},
"gallery": {"resourceGroupName": "spotinst-azure",
"galleryName": "gallery-name",
"imageName": "gallery-image-name",
"version": "0.0.1"
}
},
"network": {"resourceGroupName": "subnetResourceGroup",
"virtualNetworkName": "vname",
"networkInterfaces": [{"isPrimary": true,
"subnetName": "testSubnet",
"assignPublicIp": true,
"publicIpSku": "STANDARD",
"securityGroup": {"name": "test",
"resourceGroupName": "test"
},
"publicIps": [{"resourceGroupName": "resourceGroup",
"name": "name"
}
],
"enableIPForwarding": true,
"additionalIpConfigurations": [{"name": "test",
"privateIpAddressVersion": "IPv4"
}
],
"privateIpAddresses": [["172.23.4.20"
]
],
"applicationSecurityGroups": [{"resourceGroupName": "AsgResourceGroup",
"name": "AsgName"
}
]
}
]
},
"login": {"userName": "spotinst",
"sshPublicKey": "ssh-rsa"
},
"loadBalancersConfig": {"loadBalancers": [{"type": "loadBalancer",
"resourceGroupName": "testResourceGroup",
"name": "testLoadBalancer",
"sku": "Standard",
"backendPoolNames": ["testBackendPool1",
"testBackendPool2"
]
}
]
},
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"extensions": [{"name": "extensionName",
"type": "customScript",
"publisher": "MMicrosoft.Azure.Extensions",
"apiVersion": "2.0",
"minorVersionAutoUpgrade": true,
"publicSettings": { },
"protectedSettings": { }
}
],
"dataDisks": [{"sizeGB": 1,
"lun": 1,
"type": "Standard_LRS"
}
],
"osDisk": {"type": "Standard_LRS",
"sizeGB": 30
},
"bootDiagnostics": {"isEnabled": true,
"type": "unmanaged",
"storageUri": "https://example.blob.core.windows.net/"
},
"secrets": [{"sourceVault": {"resourceGroupName": "string",
"name": "string"
},
"vaultCertificates": [{"certificateUrl": "string",
"certificateStore": "string"
}
]
}
]
},
"zones": [1
],
"preferredZones": [1
]
},
"health": {"healthCheckTypes": ["vmState"
],
"gracePeriod": 120,
"autoHealing": true,
"unhealthyDuration": 360
},
"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-11-01T10:50:29.000+0000"
}
],
"count": 1,
"kind": "azure:compute:group:importLoadBalancer"
}
}

Import Group From Application Gateway

Given an application gateway, constructs a valid group configuration and returns it.

Authorizations:

path Parameters

applicationGatewayName	string Example: MyExampleApplicationGatewayImport
backendPoolName	string Example: MyExampleBackendPoolName
resourceGroupName	string Example: ExampleResourceGroup

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/azure/compute/group/import/resourceGroup/myResourceGroup/applicationGateway/myApplicationGateway/backendPool/myBackendPool",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "sig-123456789",
"name": "spotinst-group",
"description": "This is my example elastigroup",
"region": "westus2",
"resourceGroupName": "spotinst-azure",
"capacity": {"target": 8,
"minimum": 2,
"maximum": 10
},
"strategy": {"spotPercentage": 50,
"drainingTimeout": 30,
"fallbackToOd": true,
"revertToSpot": {"performAt": "timeWindow"
},
"optimizationWindows": ["Mon:03:00-Wed:02:30"
],
"signals": [{"type": "vmReady",
"timeout": 180
}
]
},
"scaling": {"up": [{"policyName": "cpuScaleUp",
"metricName": "Percentage CPU",
"statistic": "Average",
"unit": "percent",
"threshold": 0.75,
"namespace": "Microsoft.Network/applicationGateways",
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"dimenstions": [{"name": "resourceName",
"value": "testApplicationGateway"
},
{"name": "resourceGroupName",
"value": "testResourceGroup"
}
],
"operator": "gte",
"action": {"type": "adjustment",
"adjustment": "2",
"target": 0,
"minimum": 0,
"maximum": 0
}
}
],
"down": [{"policyName": "cpuScaleDown",
"metricName": "Percentage CPU",
"statistic": "Average",
"unit": "percent",
"threshold": 0.25,
"namespace": "Microsoft.Network/applicationGateways",
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"dimenstions": [{"name": "resourceName",
"value": "testApplicationGateway"
},
{"name": "resourceGroupName",
"value": "testResourceGroup"
}
],
"operator": "lte",
"action": {"type": "adjustment",
"adjustment": "2",
"target": 0,
"minimum": 0,
"maximum": 0
}
}
]
},
"compute": {"vmSizes": {"odSizes": ["standard_a1_v1"
],
"spotSizes": ["standard_a2_v2"
],
"preferredSpotSizes": ["standard_a2_v2"
]
},
"os": "Linux",
"launchSpecification": {"vmNamePrefix": "prefix",
"customData": "",
"image": {"marketplace": {"publisher": "OpenLogic",
"offer": "CentOS",
"sku": "7.3",
"version": "7.3-1611"
},
"custom": {"resourceGroupName": "spotinst-azure",
"name": "custom-image-name"
},
"gallery": {"resourceGroupName": "spotinst-azure",
"galleryName": "gallery-name",
"imageName": "gallery-image-name",
"version": "0.0.1"
}
},
"network": {"resourceGroupName": "subnetResourceGroup",
"virtualNetworkName": "vname",
"networkInterfaces": [{"isPrimary": true,
"subnetName": "testSubnet",
"assignPublicIp": true,
"publicIpSku": "STANDARD",
"securityGroup": {"name": "test",
"resourceGroupName": "test"
},
"publicIps": [{"resourceGroupName": "resourceGroup",
"name": "name"
}
],
"enableIPForwarding": true,
"additionalIpConfigurations": [{"name": "test",
"privateIpAddressVersion": "IPv4"
}
],
"privateIpAddresses": [["172.23.4.20"
]
],
"applicationSecurityGroups": [{"resourceGroupName": "AsgResourceGroup",
"name": "AsgName"
}
]
}
]
},
"login": {"userName": "spotinst",
"sshPublicKey": "ssh-rsa"
},
"loadBalancersConfig": {"loadBalancers": [{"type": "loadBalancer",
"resourceGroupName": "testResourceGroup",
"name": "testLoadBalancer",
"sku": "Standard",
"backendPoolNames": ["testBackendPool1",
"testBackendPool2"
]
}
]
},
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"extensions": [{"name": "extensionName",
"type": "customScript",
"publisher": "MMicrosoft.Azure.Extensions",
"apiVersion": "2.0",
"minorVersionAutoUpgrade": true,
"publicSettings": { },
"protectedSettings": { }
}
],
"dataDisks": [{"sizeGB": 1,
"lun": 1,
"type": "Standard_LRS"
}
],
"osDisk": {"type": "Standard_LRS",
"sizeGB": 30
},
"bootDiagnostics": {"isEnabled": true,
"type": "unmanaged",
"storageUri": "https://example.blob.core.windows.net/"
},
"secrets": [{"sourceVault": {"resourceGroupName": "string",
"name": "string"
},
"vaultCertificates": [{"certificateUrl": "string",
"certificateStore": "string"
}
]
}
]
},
"zones": [1
],
"preferredZones": [1
]
},
"health": {"healthCheckTypes": ["vmState"
],
"gracePeriod": 120,
"autoHealing": true,
"unhealthyDuration": 360
},
"createdAt": "2018-10-10T10:50:29.000+0000",
"updatedAt": "2018-11-01T10:50:29.000+0000"
}
],
"count": 1,
"kind": "azure:compute:group:importApplicationGateway"
}
}

Create VM Signal

The VM signal API is used for notifying Spot about the VM state so that Spot can act accordingly. Supported signals are vmReady – Whenever this signal is sent, Spot will register the instance to the relevant Load Balancer and Application Gateway. vmReadyToShutdown – When this signal is received after a vm is detached; we will immediately terminate the vm. You must define the expected signals for your Elastigroup in the group configuration.

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

signalType required	string Enum: "vmReady" "vmReadyToShutdown" The specific signal you want to trigger.
vmName required	string The virtual machine ID the signal refers to.

Responses

Request samples

Payload

Content type

application/json

{"vmName": "vm-123456",
"signalType": "vmReady"
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Virtual Machine Protection

Protect virtual machines in Elastigroup cluster.

Authorizations:

path Parameters

groupId required	string Example: sig-12345 The Spot Elastigroup ID you want to update
vmName required	string Example: i-f2a44ba41875 The virtual machine name to protect.

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
ttlInMinutes	integer Example: ttlInMinutes=180 Specify a TTL (in minutes) for this protection, meaning, for how long the protection will be valid for. (If null, infinite protection)

Responses

Response samples

Content type

application/json

{"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Virtual Machine Remove Protection

Un-Protect virtual machines in Elastigroup cluster.

Authorizations:

path Parameters

groupId required	string Example: sig-12345 The Spot Elastigroup ID you want to update
vmName required	string Example: i-f2a44ba41875 The virtual machine name to remove protection.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Get Elastilog

You can fetch a Elastigroup's Elastilog via the Spot API, in order to be able to consume elastilog from various tools used for log storing and analyzing. Logs have retention of 3 months back from today, so minimal fromDate should be up to 3 months back at runtime.

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

The Spot Elastigroup ID you want to update

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
required	unix (string) or dateTime (string) Example: fromDate=2020-09-01 or fromDate=1598918400000 Get items on or after this date (ISO 8601 or Unix timestamp)
limit	integer [ 0 .. 1000 ] Example: limit=500 Maximum number of lines to extract in a response. Max value allowed - 1000. Default is 500, if got null.
RESOURCE_ID	string Example: RESOURCE_ID=vm-12345678 Filter log extracted entires related to a specific resource id Default: Null
SEVERITY	string Enum: "DEBUG" "WARN" "INFO" "ALL" "ERROR" Example: SEVERITY=WARN Severity of log entries to extract.
required	unix (string) or dateTime (string) Example: toDate=2020-09-01 or toDate=1598918400000 Get items on or before this date (ISO 8601 or Unix timestamp)

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"message": "Successfully detached [vm-b4ab9da435aa]",
"severity": "INFO",
"createdAt": "2020-07-16T16:46:49.000Z"
}
],
"count": 1,
"kind": "spotinst:aws:ec2:group:log"
}
}

Elastigroup Azure Scale Set VMs

Elastigroup for Microsoft Azure Scale Set

List Elastigroups

List all Azure Elastigroups for a Spot Account

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"group": {"id": "sig-123456789",
"name": "spotinst-group",
"region": "eastus",
"resourceGroupName": "spotinst-azure",
"capacity": {"target": 8,
"minimum": 2,
"maximum": 10
},
"scaling": {"up": [{"policyName": "cpuScaleUp",
"metricName": "Percentage CPU",
"statistic": "average",
"threshold": 0.75,
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"namespace": "Microsoft.Network/applicationGateways",
"operator": "gte",
"dimenstions": [{"name": "resourceName",
"value": "TestAppGateway"
}
],
"action": {"type": "adjustment",
"adjustment": "2"
}
}
],
"down": [{"policyName": "cpuScaleDown",
"metricName": "Percentage CPU",
"statistic": "average",
"threshold": 0.25,
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"namespace": "Microsoft.Network/applicationGateways",
"operator": "lte",
"dimenstions": [{"name": "resourceName",
"value": "TestAppGateway"
}
],
"action": {"type": "adjustment",
"adjustment": "2"
}
}
]
},
"strategy": {"lowPriorityPercentage": 0,
"odCount": 0,
"drainingTimeout": 0
},
"compute": {"vmSizes": {"odSizes": ["standard_a1_v1"
],
"lowPrioritySizes": ["standard_a2_v2"
]
},
"product": "Linux",
"health": {"autoHealing": true,
"healthCheckType": "INSTANCE_STATE",
"gracePeriod": 120
},
"launchSpecification": {"image": {"marketplace": {"publisher": "OpenLogic",
"offer": "CentOS",
"sku": "7.3",
"version": "7.3-1611"
},
"shutdownScript": "IyEvdXNyL2Jpbi9lbnYgYmFzaAoiR29vZGJ5ZSBvbGQgaW5zdGFuY2Ui",
"custom": {"resourceGroupName": "spotinst-azure",
"imageName": "custom-image-name"
}
},
"loadBalancersConfig": {"loadBalancers": [{"type": "MULTAI_TARGET_SET",
"balancerId": "lb-1ee2e3q",
"targetSetId": "ts-3eq",
"autoWeight": true
}
]
},
"userData": "string",
"managedServiceIdentities": [{"name": null,
"example": null
}
],
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"network": {"virtualNetworkName": "vname",
"subnetName": "my-subnet-name",
"resourceGroupName": "subnetResourceGroup",
"assignPublicIp": null,
"additionalIpConfigurations": [{"name": "config1",
"privateIpAddressVersion": "IPv4"
}
]
},
"extensions": [{"autoUpgradeMinorVersion": true,
"name": "k8s-agentpool1-38611891-vmss-computeAksLinuxBilling",
"protectedSettings": null,
"publisher": "Microsoft.AKS",
"type": "Compute.AKS-Engine.Linux.Billing",
"typeHandlerVersion": "1.0"
}
],
"customData": "string",
"login": {"userName": "spotinst",
"sshPublicKey": "string",
"password": "string"
}
}
},
"thirdPartiesIntegration": {"kubernetes": {"clusterIdentifier": "aks-engine-cluser"
},
"hpcGridEngine": {"clusterId": "spotinst-uge-cluster",
"queues": [{"name": "burst.q"
}
],
"distribution": "sge",
"tortuga": {"softwareProfile": "execd",
"hardwareProfile": "execd-elastigroup"
}
}
}
}
}
],
"count": 1,
"kind": "string"
}
}

Create Elastigroup

Create a new Azure Elastigroup

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

required

object (Azure Elastigroup)

Azure Elastigroup Configuration

required	object Capacity of Elastigroup
required	object (Compute) Elastigroup's Compute Configurtion
name required	string Azure Elastigroup Name
region required	string Valid Azure region the Elastigroup is managed in
resourceGroupName required	string The Azure resource group to associate the Elastigroup with
	object (Azure Scaling) Scaling Policies for Elastigroup. Set as many policies as needed to maximize the Elastigroup’s efficiency.
required	object (Scaling Strategy)
	object (Third Parties Integration) Settings for 3rd party integrations on group.

Responses

Request samples

Payload

Content type

application/json

{"group": {"name": "spotinst-group",
"region": "eastus",
"resourceGroupName": "spotinst-azure",
"capacity": {"target": 8,
"minimum": 2,
"maximum": 10
},
"scaling": {"up": {"policyName": "cpuScale",
"metricName": "Percentage CPU",
"statistic": "average",
"threshold": 0.75,
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"namespace": "Microsoft.Network/applicationGateways",
"operator": "gte",
"dimenstions": [{"name": "resourceName",
"value": "TestAppGateway"
}
],
"action": {"type": "adjustment",
"adjustment": "2",
"minTargetCapacity": null,
"target": 23,
"minimum": 20,
"maximum": 25
}
},
"down": {"policyName": "cpuScale",
"metricName": "Percentage CPU",
"statistic": "average",
"threshold": 0.75,
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"namespace": "Microsoft.Network/applicationGateways",
"operator": "gte",
"dimenstions": [{"name": "resourceName",
"value": "TestAppGateway"
}
],
"action": {"type": "adjustment",
"target": 1,
"minimum": 1,
"maximum": 1,
"adjustment": "2"
}
}
},
"strategy": {"lowPriorityPercentage": 100,
"onDemandCount": 0,
"drainingTimeout": 120
},
"compute": {"vmSizes": {"odSizes": ["standard_b1s"
],
"lowPrioritySizes": ["standard_a2_v2"
]
},
"product": "Linux",
"health": {"autoHealing": true,
"healthCheckType": "INSTANCE_STATE",
"gracePeriod": 120,
"unhealthyDuration": 360
},
"launchSpecification": {"image": {"marketplace": {"publisher": "OpenLogic",
"offer": "CentOS",
"sku": "7.3",
"version": "7.3-1611"
},
"custom": {"resourceGroupName": "spotinst-azure",
"imageName": "custom-image-name"
}
},
"loadBalancersConfig": {"loadBalancers": [{"type": "MULTAI_TARGET_SET",
"balancerId": "lb-1ee2e3q",
"targetSetId": "ts-3eq",
"autoWeight": true
}
]
},
"userData": "IyEvYmluL2Jhc2gKZWNobyAidGVzdCI=",
"managedServiceIdentities": [{"resourceGroupName": "Resourse Group 1",
"name": "Test"
}
],
"shutdownScript": "IyEvYmluL2Jhc2gKZWNobyAidGVzdCI=",
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"network": {"virtualNetworkName": "vname",
"subnetName": "my-subnet-name",
"resourceGroupName": "subnetResourceGroup",
"assignPublicIp": true,
"additionalIPConfigurations": [{"name": "config1",
"privateIpAddressVersion": "IPv4"
}
]
},
"extensions": [{"autoUpgradeMinorVersion": true,
"name": "k8s-agentpool1-38611891-vmss-computeAksLinuxBilling",
"protectedSettings": {"commandToExecute": "string"
},
"publisher": "Microsoft.AKS",
"type": "Compute.AKS-Engine.Linux.Billing",
"typeHandlerVersion": "1.0"
}
],
"customData": "IyEvYmluL2Jhc2gKZWNobyAidGVzdCI=",
"login": [{"userName": "spotinst",
"sshPublicKey": "string",
"password": "string"
}
]
}
},
"thirdPartiesIntegration": {"kubernetes": {"clusterIdentifier": "aks-engine-cluser",
"autoScale": {"isEnabled": true,
"isAutoConfig": false,
"cooldown": 180,
"down": {"maxScaleDownPercentage": 50
},
"headroom": {"cpuPerUnit": 2,
"memoryPerUnit": 2,
"gpuPerUnit": 2,
"numOfUnits": 2
},
"labels": [{"key": "group",
"value": "microservices"
}
],
"resourceLimits": {"maxVCpu": 4,
"maxMemoryGib": 4
}
}
},
"hpcGridEngine": {"clusterId": "spotinst-uge-cluster",
"queues": [{"name": "burst.q"
}
],
"distribution": "sge"
}
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"group": {"id": "sig-123456789",
"name": "spotinst-group",
"region": "eastus",
"resourceGroupName": "spotinst-azure",
"capacity": {"target": 8,
"minimum": 2,
"maximum": 10
},
"scaling": {"up": [{"policyName": "cpuScaleUp",
"metricName": "Percentage CPU",
"statistic": "average",
"threshold": 0.75,
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"namespace": "Microsoft.Network/applicationGateways",
"operator": "gte",
"dimenstions": [{"name": "resourceName",
"value": "TestAppGateway"
}
],
"action": {"type": "adjustment",
"adjustment": "2"
}
}
],
"down": [{"policyName": "cpuScaleDown",
"metricName": "Percentage CPU",
"statistic": "average",
"threshold": 0.25,
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"namespace": "Microsoft.Network/applicationGateways",
"operator": "lte",
"dimenstions": [{"name": "resourceName",
"value": "TestAppGateway"
}
],
"action": {"type": "adjustment",
"adjustment": "2"
}
}
]
},
"strategy": {"lowPriorityPercentage": 0,
"odCount": 0,
"drainingTimeout": 0
},
"compute": {"vmSizes": {"odSizes": ["standard_a1_v1"
],
"lowPrioritySizes": ["standard_a2_v2"
]
},
"product": "Linux",
"health": {"autoHealing": true,
"healthCheckType": "INSTANCE_STATE",
"gracePeriod": 120
},
"launchSpecification": {"image": {"marketplace": {"publisher": "OpenLogic",
"offer": "CentOS",
"sku": "7.3",
"version": "7.3-1611"
},
"shutdownScript": "IyEvdXNyL2Jpbi9lbnYgYmFzaAoiR29vZGJ5ZSBvbGQgaW5zdGFuY2Ui",
"custom": {"resourceGroupName": "spotinst-azure",
"imageName": "custom-image-name"
}
},
"loadBalancersConfig": {"loadBalancers": [{"type": "MULTAI_TARGET_SET",
"balancerId": "lb-1ee2e3q",
"targetSetId": "ts-3eq",
"autoWeight": true
}
]
},
"userData": "string",
"managedServiceIdentities": [{"name": null,
"example": null
}
],
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"network": {"virtualNetworkName": "vname",
"subnetName": "my-subnet-name",
"resourceGroupName": "subnetResourceGroup",
"assignPublicIp": null,
"additionalIpConfigurations": [{"name": "config1",
"privateIpAddressVersion": "IPv4"
}
]
},
"extensions": [{"autoUpgradeMinorVersion": true,
"name": "k8s-agentpool1-38611891-vmss-computeAksLinuxBilling",
"protectedSettings": null,
"publisher": "Microsoft.AKS",
"type": "Compute.AKS-Engine.Linux.Billing",
"typeHandlerVersion": "1.0"
}
],
"customData": "string",
"login": {"userName": "spotinst",
"sshPublicKey": "string",
"password": "string"
}
}
},
"thirdPartiesIntegration": {"kubernetes": {"clusterIdentifier": "aks-engine-cluser"
},
"hpcGridEngine": {"clusterId": "spotinst-uge-cluster",
"queues": [{"name": "burst.q"
}
],
"distribution": "sge",
"tortuga": {"softwareProfile": "execd",
"hardwareProfile": "execd-elastigroup"
}
}
}
}
}
],
"count": 1,
"kind": "string"
}
}

Delete Elastigroup

Delete an Elastigroup Azure

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

Elastigroup ID

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Get Elastigroup

List all properties for single Azure Elastigroup

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

Elastigroup ID

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"group": {"id": "sig-123456789",
"name": "spotinst-group",
"region": "eastus",
"resourceGroupName": "spotinst-azure",
"capacity": {"target": 8,
"minimum": 2,
"maximum": 10
},
"scaling": {"up": [{"policyName": "cpuScaleUp",
"metricName": "Percentage CPU",
"statistic": "average",
"threshold": 0.75,
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"namespace": "Microsoft.Network/applicationGateways",
"operator": "gte",
"dimenstions": [{"name": "resourceName",
"value": "TestAppGateway"
}
],
"action": {"type": "adjustment",
"adjustment": "2"
}
}
],
"down": [{"policyName": "cpuScaleDown",
"metricName": "Percentage CPU",
"statistic": "average",
"threshold": 0.25,
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"namespace": "Microsoft.Network/applicationGateways",
"operator": "lte",
"dimenstions": [{"name": "resourceName",
"value": "TestAppGateway"
}
],
"action": {"type": "adjustment",
"adjustment": "2"
}
}
]
},
"strategy": {"lowPriorityPercentage": 0,
"odCount": 0,
"drainingTimeout": 0
},
"compute": {"vmSizes": {"odSizes": ["standard_a1_v1"
],
"lowPrioritySizes": ["standard_a2_v2"
]
},
"product": "Linux",
"health": {"autoHealing": true,
"healthCheckType": "INSTANCE_STATE",
"gracePeriod": 120
},
"launchSpecification": {"image": {"marketplace": {"publisher": "OpenLogic",
"offer": "CentOS",
"sku": "7.3",
"version": "7.3-1611"
},
"shutdownScript": "IyEvdXNyL2Jpbi9lbnYgYmFzaAoiR29vZGJ5ZSBvbGQgaW5zdGFuY2Ui",
"custom": {"resourceGroupName": "spotinst-azure",
"imageName": "custom-image-name"
}
},
"loadBalancersConfig": {"loadBalancers": [{"type": "MULTAI_TARGET_SET",
"balancerId": "lb-1ee2e3q",
"targetSetId": "ts-3eq",
"autoWeight": true
}
]
},
"userData": "string",
"managedServiceIdentities": [{"name": null,
"example": null
}
],
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"network": {"virtualNetworkName": "vname",
"subnetName": "my-subnet-name",
"resourceGroupName": "subnetResourceGroup",
"assignPublicIp": null,
"additionalIpConfigurations": [{"name": "config1",
"privateIpAddressVersion": "IPv4"
}
]
},
"extensions": [{"autoUpgradeMinorVersion": true,
"name": "k8s-agentpool1-38611891-vmss-computeAksLinuxBilling",
"protectedSettings": null,
"publisher": "Microsoft.AKS",
"type": "Compute.AKS-Engine.Linux.Billing",
"typeHandlerVersion": "1.0"
}
],
"customData": "string",
"login": {"userName": "spotinst",
"sshPublicKey": "string",
"password": "string"
}
}
},
"thirdPartiesIntegration": {"kubernetes": {"clusterIdentifier": "aks-engine-cluser"
},
"hpcGridEngine": {"clusterId": "spotinst-uge-cluster",
"queues": [{"name": "burst.q"
}
],
"distribution": "sge",
"tortuga": {"softwareProfile": "execd",
"hardwareProfile": "execd-elastigroup"
}
}
}
}
}
],
"count": 1,
"kind": "string"
}
}

Update Elastigroup

Update an Azure Elastigroup

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

required

object

	object
	object
name	string Azure Elastigroup Name
region	string Valid Azure region the Elastigroup is managed in
resourceGroupName	string The Azure resource group to associate the Elastigroup with
	object (Azure Scaling)
	object (Scaling Strategy)
	object

Responses

Request samples

Payload

Content type

application/json

{"group": {"name": "spotinst-group",
"region": "eastus",
"resourceGroupName": "spotinst-azure",
"capacity": {"target": 8,
"minimum": 2,
"maximum": 10
},
"scaling": {"up": [{"policyName": "cpuScaleUp",
"metricName": "Percentage CPU",
"statistic": "average",
"threshold": 0.75,
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"namespace": "Microsoft.Network/applicationGateways",
"operator": "gte",
"dimenstions": [{"name": "resourceName",
"value": "TestAppGateway"
}
],
"action": {"type": "adjustment",
"adjustment": "2"
}
}
],
"down": [{"policyName": "cpuScaleDown",
"metricName": "Percentage CPU",
"statistic": "average",
"threshold": 0.25,
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"namespace": "Microsoft.Network/applicationGateways",
"operator": "lte",
"dimenstions": [{"name": "resourceName",
"value": "TestAppGateway"
}
],
"action": {"type": "adjustment",
"adjustment": "2"
}
}
]
},
"strategy": {"lowPriorityPercentage": 0,
"odCount": 0,
"drainingTimeout": 0
},
"compute": {"vmSizes": {"odSizes": ["standard_a1_v1"
],
"lowPrioritySizes": ["standard_a2_v2"
]
},
"product": "Linux",
"health": {"autoHealing": true,
"healthCheckType": "INSTANCE_STATE",
"gracePeriod": 120
},
"launchSpecification": {"image": {"marketplace": {"publisher": "OpenLogic",
"offer": "CentOS",
"sku": "7.3",
"version": "7.3-1611"
},
"shutdownScript": "IyEvdXNyL2Jpbi9lbnYgYmFzaAoiR29vZGJ5ZSBvbGQgaW5zdGFuY2Ui",
"custom": {"resourceGroupName": "spotinst-azure",
"imageName": "custom-image-name"
}
},
"loadBalancersConfig": {"loadBalancers": [{"type": "MULTAI_TARGET_SET",
"balancerId": "lb-1ee2e3q",
"targetSetId": "ts-3eq",
"autoWeight": true
}
]
},
"userData": "string",
"managedServiceIdentities": [{"name": null,
"example": null
}
],
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"network": {"virtualNetworkName": "vname",
"subnetName": "my-subnet-name",
"resourceGroupName": "subnetResourceGroup",
"assignPublicIp": null,
"additionalIpConfigurations": [{"name": "config1",
"privateIpAddressVersion": "IPv4"
}
]
},
"extensions": [{"autoUpgradeMinorVersion": true,
"name": "k8s-agentpool1-38611891-vmss-computeAksLinuxBilling",
"protectedSettings": null,
"publisher": "Microsoft.AKS",
"type": "Compute.AKS-Engine.Linux.Billing",
"typeHandlerVersion": "1.0"
}
],
"customData": "string",
"login": {"userName": "spotinst",
"sshPublicKey": "string",
"password": "string"
}
}
},
"thirdPartiesIntegration": {"kubernetes": {"clusterIdentifier": "aks-engine-cluser"
},
"hpcGridEngine": {"clusterId": "spotinst-uge-cluster",
"queues": [{"name": "burst.q"
}
],
"distribution": "sge",
"tortuga": {"softwareProfile": "execd",
"hardwareProfile": "execd-elastigroup"
}
}
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"group": {"id": "sig-123456789",
"name": "spotinst-group",
"region": "eastus",
"resourceGroupName": "spotinst-azure",
"capacity": {"target": 8,
"minimum": 2,
"maximum": 10
},
"scaling": {"up": [{"policyName": "cpuScaleUp",
"metricName": "Percentage CPU",
"statistic": "average",
"threshold": 0.75,
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"namespace": "Microsoft.Network/applicationGateways",
"operator": "gte",
"dimenstions": [{"name": "resourceName",
"value": "TestAppGateway"
}
],
"action": {"type": "adjustment",
"adjustment": "2"
}
}
],
"down": [{"policyName": "cpuScaleDown",
"metricName": "Percentage CPU",
"statistic": "average",
"threshold": 0.25,
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"namespace": "Microsoft.Network/applicationGateways",
"operator": "lte",
"dimenstions": [{"name": "resourceName",
"value": "TestAppGateway"
}
],
"action": {"type": "adjustment",
"adjustment": "2"
}
}
]
},
"strategy": {"lowPriorityPercentage": 0,
"odCount": 0,
"drainingTimeout": 0
},
"compute": {"vmSizes": {"odSizes": ["standard_a1_v1"
],
"lowPrioritySizes": ["standard_a2_v2"
]
},
"product": "Linux",
"health": {"autoHealing": true,
"healthCheckType": "INSTANCE_STATE",
"gracePeriod": 120
},
"launchSpecification": {"image": {"marketplace": {"publisher": "OpenLogic",
"offer": "CentOS",
"sku": "7.3",
"version": "7.3-1611"
},
"shutdownScript": "IyEvdXNyL2Jpbi9lbnYgYmFzaAoiR29vZGJ5ZSBvbGQgaW5zdGFuY2Ui",
"custom": {"resourceGroupName": "spotinst-azure",
"imageName": "custom-image-name"
}
},
"loadBalancersConfig": {"loadBalancers": [{"type": "MULTAI_TARGET_SET",
"balancerId": "lb-1ee2e3q",
"targetSetId": "ts-3eq",
"autoWeight": true
}
]
},
"userData": "string",
"managedServiceIdentities": [{"name": null,
"example": null
}
],
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"network": {"virtualNetworkName": "vname",
"subnetName": "my-subnet-name",
"resourceGroupName": "subnetResourceGroup",
"assignPublicIp": null,
"additionalIpConfigurations": [{"name": "config1",
"privateIpAddressVersion": "IPv4"
}
]
},
"extensions": [{"autoUpgradeMinorVersion": true,
"name": "k8s-agentpool1-38611891-vmss-computeAksLinuxBilling",
"protectedSettings": null,
"publisher": "Microsoft.AKS",
"type": "Compute.AKS-Engine.Linux.Billing",
"typeHandlerVersion": "1.0"
}
],
"customData": "string",
"login": {"userName": "spotinst",
"sshPublicKey": "string",
"password": "string"
}
}
},
"thirdPartiesIntegration": {"kubernetes": {"clusterIdentifier": "aks-engine-cluser"
},
"hpcGridEngine": {"clusterId": "spotinst-uge-cluster",
"queues": [{"name": "burst.q"
}
],
"distribution": "sge",
"tortuga": {"softwareProfile": "execd",
"hardwareProfile": "execd-elastigroup"
}
}
}
}
}
],
"count": 1,
"kind": "string"
}
}

Get Elastigroup Status

Get the status for all instances that are memebers of the Elastigroup

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

Elastigroup ID

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"instanceId": "ec5410ea-fec7-4a03-a989-3b27b7ee2ed5",
"region": "eastus",
"vmSize": "standard_a1_v2",
"lifeCycle": "low-priority",
"privateIp": "10.0.0.8",
"publicIp": "168.62.168.93",
"state": "running",
"createdAt": "2018-06-20T11:16:32.000Z"
}
],
"count": 1,
"kind": "string"
}
}

Detach Instances

Detach one or more instances from an Azure Elastigroup

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

Elastigroup ID

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

drainingTimeout	integer
instancesToDetach	Array of strings
shouldDecrementTargetCapacity	boolean

Responses

Request samples

Payload

Content type

application/json

{"instancesToDetach": ["string"
],
"shouldDecrementTargetCapacity": true,
"drainingTimeout": 300
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"detachedOd": ["string"
],
"detachedLowPriority": ["string"
]
}
],
"count": 1,
"kind": "string"
}
}

List Deployments

Historical list of all deployments for an Azure Elastigroup

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

Elastigroup ID

query Parameters

accountId	string Example: accountId=act-123abc Your Spotinst accountid associated with your token
limit	integer Example: limit=5 Limits results
sort	integer Example: sort=created:ASC Field to sort by the results

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "sbgd-9876",
"status": "ROLL_STARTING"
}
],
"count": 1,
"kind": "string"
}
}

Start Deployment

Start a new Azure Elastigroup deployment

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

Elastigroup ID

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

batchSizePercentage	integer (Batch Size Percentage) Indicates (in percentage) the batch size of the roll (meaning, how many nodes to replace in each batch)
gracePeriod	integer (Grace Period) Indicates (in seconds) the timeout to wait until node become healthy in the ELB
healthCheckType	string (Health Check Type) Define a health check type. valid values: mlb, node_state, none (wait the entire grace period for each batch). If no value is set the roll will use the group’s auto-healing health check.

Responses

Request samples

Payload

Content type

application/json

{"batchSizePercentage": 50,
"gracePeriod": 300,
"healthCheckType": "INSTANCE_STATE"
}

Response samples

Content type

application/json

{"request": {"id": "46642c7d-bc29-417d-8ce4-79626f00c63c",
"url": "/compute/azure/group/sig-12345/roll",
"method": "PUT",
"timestamp": "2016-01-21T17:12:51.451Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:aws:ec2:group",
"items": [{"id": "sbgd-9876",
"status": "ROLL_STARTING",
"currentBatch": 1,
"numOfBatches": 2,
"progress": {"unit": "percentage",
"value": 10
},
"groupId": "sig-12345"
}
],
"count": 1
}
}

Roll Status

Get status of a specific roll

Authorizations:

path Parameters

groupId required	string Example: sig-12345 The Elasticgroup id you want to roll
rollId required	string Example: sbgd-9876 The roll id you want to query

query Parameters

accountId

string

Example: accountId=act-123abc

Your Spotinst accountid associated with your token

Responses

Response samples

Content type

application/json

{"request": {"id": "46642c7d-bc29-417d-8ce4-79626f00c63c",
"url": "/compute/azure/group/sig-12345/roll/sbgd-dfb956b4",
"method": "GET",
"timestamp": "2016-01-21T17:12:51.451Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:aws:ec2:group",
"items": [{"id": "sbgd-9876",
"status": "ROLL_FINISHED",
"progress": {"unit": "percent",
"value": 100
},
"createdAt": "2017-01-31T13:54:53.000+0000",
"updatedAt": "2017-01-31T14:26:37.000+0000"
}
],
"count": 1
}
}

Update Task

Update an Elastigroup Azure

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

required

object

	object
	object
name required	string Azure Elastigroup Name
region	string Valid Azure region the Elastigroup is managed in
resourceGroupName	string The Azure resource group to associate the Elastigroup with
	object (Azure Scaling)
	object (Scaling Strategy)
	object

Responses

Request samples

Payload

Content type

application/json

{"group": {"name": "spotinst-group",
"region": "eastus",
"resourceGroupName": "spotinst-azure",
"capacity": {"target": 8,
"minimum": 2,
"maximum": 10
},
"scaling": {"up": [{"policyName": "cpuScaleUp",
"metricName": "Percentage CPU",
"statistic": "average",
"threshold": 0.75,
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"namespace": "Microsoft.Network/applicationGateways",
"operator": "gte",
"dimenstions": [{"name": "resourceName",
"value": "TestAppGateway"
}
],
"action": {"type": "adjustment",
"adjustment": "2"
}
}
],
"down": [{"policyName": "cpuScaleDown",
"metricName": "Percentage CPU",
"statistic": "average",
"threshold": 0.25,
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"namespace": "Microsoft.Network/applicationGateways",
"operator": "lte",
"dimenstions": [{"name": "resourceName",
"value": "TestAppGateway"
}
],
"action": {"type": "adjustment",
"adjustment": "2"
}
}
]
},
"strategy": {"lowPriorityPercentage": 0,
"odCount": 0,
"drainingTimeout": 0
},
"compute": {"vmSizes": {"odSizes": ["standard_a1_v1"
],
"lowPrioritySizes": ["standard_a2_v2"
]
},
"product": "Linux",
"health": {"autoHealing": true,
"healthCheckType": "INSTANCE_STATE",
"gracePeriod": 120
},
"launchSpecification": {"image": {"marketplace": {"publisher": "OpenLogic",
"offer": "CentOS",
"sku": "7.3",
"version": "7.3-1611"
},
"shutdownScript": "IyEvdXNyL2Jpbi9lbnYgYmFzaAoiR29vZGJ5ZSBvbGQgaW5zdGFuY2Ui",
"custom": {"resourceGroupName": "spotinst-azure",
"imageName": "custom-image-name"
}
},
"loadBalancersConfig": {"loadBalancers": [{"type": "MULTAI_TARGET_SET",
"balancerId": "lb-1ee2e3q",
"targetSetId": "ts-3eq",
"autoWeight": true
}
]
},
"userData": "string",
"managedServiceIdentities": [{"name": null,
"example": null
}
],
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"network": {"virtualNetworkName": "vname",
"subnetName": "my-subnet-name",
"resourceGroupName": "subnetResourceGroup",
"assignPublicIp": null,
"additionalIpConfigurations": [{"name": "config1",
"privateIpAddressVersion": "IPv4"
}
]
},
"extensions": [{"autoUpgradeMinorVersion": true,
"name": "k8s-agentpool1-38611891-vmss-computeAksLinuxBilling",
"protectedSettings": null,
"publisher": "Microsoft.AKS",
"type": "Compute.AKS-Engine.Linux.Billing",
"typeHandlerVersion": "1.0"
}
],
"customData": "string",
"login": {"userName": "spotinst",
"sshPublicKey": "string",
"password": "string"
}
}
},
"thirdPartiesIntegration": {"kubernetes": {"clusterIdentifier": "aks-engine-cluser"
},
"hpcGridEngine": {"clusterId": "spotinst-uge-cluster",
"queues": [{"name": "burst.q"
}
],
"distribution": "sge",
"tortuga": {"softwareProfile": "execd",
"hardwareProfile": "execd-elastigroup"
}
}
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"group": {"id": "sig-123456789",
"name": "spotinst-group",
"region": "eastus",
"resourceGroupName": "spotinst-azure",
"capacity": {"target": 8,
"minimum": 2,
"maximum": 10
},
"scaling": {"up": [{"policyName": "cpuScaleUp",
"metricName": "Percentage CPU",
"statistic": "average",
"threshold": 0.75,
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"namespace": "Microsoft.Network/applicationGateways",
"operator": "gte",
"dimenstions": [{"name": "resourceName",
"value": "TestAppGateway"
}
],
"action": {"type": "adjustment",
"adjustment": "2"
}
}
],
"down": [{"policyName": "cpuScaleDown",
"metricName": "Percentage CPU",
"statistic": "average",
"threshold": 0.25,
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"namespace": "Microsoft.Network/applicationGateways",
"operator": "lte",
"dimenstions": [{"name": "resourceName",
"value": "TestAppGateway"
}
],
"action": {"type": "adjustment",
"adjustment": "2"
}
}
]
},
"strategy": {"lowPriorityPercentage": 0,
"odCount": 0,
"drainingTimeout": 0
},
"compute": {"vmSizes": {"odSizes": ["standard_a1_v1"
],
"lowPrioritySizes": ["standard_a2_v2"
]
},
"product": "Linux",
"health": {"autoHealing": true,
"healthCheckType": "INSTANCE_STATE",
"gracePeriod": 120
},
"launchSpecification": {"image": {"marketplace": {"publisher": "OpenLogic",
"offer": "CentOS",
"sku": "7.3",
"version": "7.3-1611"
},
"shutdownScript": "IyEvdXNyL2Jpbi9lbnYgYmFzaAoiR29vZGJ5ZSBvbGQgaW5zdGFuY2Ui",
"custom": {"resourceGroupName": "spotinst-azure",
"imageName": "custom-image-name"
}
},
"loadBalancersConfig": {"loadBalancers": [{"type": "MULTAI_TARGET_SET",
"balancerId": "lb-1ee2e3q",
"targetSetId": "ts-3eq",
"autoWeight": true
}
]
},
"userData": "string",
"managedServiceIdentities": [{"name": null,
"example": null
}
],
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"network": {"virtualNetworkName": "vname",
"subnetName": "my-subnet-name",
"resourceGroupName": "subnetResourceGroup",
"assignPublicIp": null,
"additionalIpConfigurations": [{"name": "config1",
"privateIpAddressVersion": "IPv4"
}
]
},
"extensions": [{"autoUpgradeMinorVersion": true,
"name": "k8s-agentpool1-38611891-vmss-computeAksLinuxBilling",
"protectedSettings": null,
"publisher": "Microsoft.AKS",
"type": "Compute.AKS-Engine.Linux.Billing",
"typeHandlerVersion": "1.0"
}
],
"customData": "string",
"login": {"userName": "spotinst",
"sshPublicKey": "string",
"password": "string"
}
}
},
"thirdPartiesIntegration": {"kubernetes": {"clusterIdentifier": "aks-engine-cluser"
},
"hpcGridEngine": {"clusterId": "spotinst-uge-cluster",
"queues": [{"name": "burst.q"
}
],
"distribution": "sge",
"tortuga": {"softwareProfile": "execd",
"hardwareProfile": "execd-elastigroup"
}
}
}
}
}
],
"count": 1,
"kind": "string"
}
}

Get Deployment

Describe a single deployment for an Azure Elastigroup

Authorizations:

path Parameters

deploymentId required	string Example: sbgd-9876 Azure Elastigroup ID
groupId required	string Example: sig-12345 Elastigroup ID

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "sbgd-9876",
"status": "ROLL_STARTING"
}
],
"count": 1,
"kind": "string"
}
}

Stop Deployment

Stop a deployment

Authorizations:

path Parameters

deploymentId required	string Example: sbgd-9876 Azure Elastigroup ID
groupId required	string Example: sig-12345 Elastigroup ID

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

object

status

string

Default: "ROLL_STOPPED"

set the status of the roll to ROLL_STOPPED

Responses

Request samples

Payload

Content type

application/json

{"roll": {"status": "ROLL_STOPPED"
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

List Tasks

List all Azure Tasks for a Spot Account

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"group": {"id": "sig-123456789",
"name": "spotinst-group",
"region": "eastus",
"resourceGroupName": "spotinst-azure",
"capacity": {"target": 8,
"minimum": 2,
"maximum": 10
},
"scaling": {"up": [{"policyName": "cpuScaleUp",
"metricName": "Percentage CPU",
"statistic": "average",
"threshold": 0.75,
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"namespace": "Microsoft.Network/applicationGateways",
"operator": "gte",
"dimenstions": [{"name": "resourceName",
"value": "TestAppGateway"
}
],
"action": {"type": "adjustment",
"adjustment": "2"
}
}
],
"down": [{"policyName": "cpuScaleDown",
"metricName": "Percentage CPU",
"statistic": "average",
"threshold": 0.25,
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"namespace": "Microsoft.Network/applicationGateways",
"operator": "lte",
"dimenstions": [{"name": "resourceName",
"value": "TestAppGateway"
}
],
"action": {"type": "adjustment",
"adjustment": "2"
}
}
]
},
"strategy": {"lowPriorityPercentage": 0,
"odCount": 0,
"drainingTimeout": 0
},
"compute": {"vmSizes": {"odSizes": ["standard_a1_v1"
],
"lowPrioritySizes": ["standard_a2_v2"
]
},
"product": "Linux",
"health": {"autoHealing": true,
"healthCheckType": "INSTANCE_STATE",
"gracePeriod": 120
},
"launchSpecification": {"image": {"marketplace": {"publisher": "OpenLogic",
"offer": "CentOS",
"sku": "7.3",
"version": "7.3-1611"
},
"shutdownScript": "IyEvdXNyL2Jpbi9lbnYgYmFzaAoiR29vZGJ5ZSBvbGQgaW5zdGFuY2Ui",
"custom": {"resourceGroupName": "spotinst-azure",
"imageName": "custom-image-name"
}
},
"loadBalancersConfig": {"loadBalancers": [{"type": "MULTAI_TARGET_SET",
"balancerId": "lb-1ee2e3q",
"targetSetId": "ts-3eq",
"autoWeight": true
}
]
},
"userData": "string",
"managedServiceIdentities": [{"name": null,
"example": null
}
],
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"network": {"virtualNetworkName": "vname",
"subnetName": "my-subnet-name",
"resourceGroupName": "subnetResourceGroup",
"assignPublicIp": null,
"additionalIpConfigurations": [{"name": "config1",
"privateIpAddressVersion": "IPv4"
}
]
},
"extensions": [{"autoUpgradeMinorVersion": true,
"name": "k8s-agentpool1-38611891-vmss-computeAksLinuxBilling",
"protectedSettings": null,
"publisher": "Microsoft.AKS",
"type": "Compute.AKS-Engine.Linux.Billing",
"typeHandlerVersion": "1.0"
}
],
"customData": "string",
"login": {"userName": "spotinst",
"sshPublicKey": "string",
"password": "string"
}
}
},
"thirdPartiesIntegration": {"kubernetes": {"clusterIdentifier": "aks-engine-cluser"
},
"hpcGridEngine": {"clusterId": "spotinst-uge-cluster",
"queues": [{"name": "burst.q"
}
],
"distribution": "sge",
"tortuga": {"softwareProfile": "execd",
"hardwareProfile": "execd-elastigroup"
}
}
}
}
}
],
"count": 1,
"kind": "string"
}
}

Create Task

Create a new Azure Task

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

required

object

	object
	object
name required	string Azure Elastigroup Name
region	string Valid Azure region the Elastigroup is managed in
resourceGroupName	string The Azure resource group to associate the Elastigroup with
	object (Azure Scaling)
	object (Scaling Strategy)
	object

Responses

Request samples

Payload

Content type

application/json

{"group": {"name": "spotinst-group",
"region": "eastus",
"resourceGroupName": "spotinst-azure",
"capacity": {"target": 8,
"minimum": 2,
"maximum": 10
},
"scaling": {"up": [{"policyName": "cpuScaleUp",
"metricName": "Percentage CPU",
"statistic": "average",
"threshold": 0.75,
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"namespace": "Microsoft.Network/applicationGateways",
"operator": "gte",
"dimenstions": [{"name": "resourceName",
"value": "TestAppGateway"
}
],
"action": {"type": "adjustment",
"adjustment": "2"
}
}
],
"down": [{"policyName": "cpuScaleDown",
"metricName": "Percentage CPU",
"statistic": "average",
"threshold": 0.25,
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"namespace": "Microsoft.Network/applicationGateways",
"operator": "lte",
"dimenstions": [{"name": "resourceName",
"value": "TestAppGateway"
}
],
"action": {"type": "adjustment",
"adjustment": "2"
}
}
]
},
"strategy": {"lowPriorityPercentage": 0,
"odCount": 0,
"drainingTimeout": 0
},
"compute": {"vmSizes": {"odSizes": ["standard_a1_v1"
],
"lowPrioritySizes": ["standard_a2_v2"
]
},
"product": "Linux",
"health": {"autoHealing": true,
"healthCheckType": "INSTANCE_STATE",
"gracePeriod": 120
},
"launchSpecification": {"image": {"marketplace": {"publisher": "OpenLogic",
"offer": "CentOS",
"sku": "7.3",
"version": "7.3-1611"
},
"shutdownScript": "IyEvdXNyL2Jpbi9lbnYgYmFzaAoiR29vZGJ5ZSBvbGQgaW5zdGFuY2Ui",
"custom": {"resourceGroupName": "spotinst-azure",
"imageName": "custom-image-name"
}
},
"loadBalancersConfig": {"loadBalancers": [{"type": "MULTAI_TARGET_SET",
"balancerId": "lb-1ee2e3q",
"targetSetId": "ts-3eq",
"autoWeight": true
}
]
},
"userData": "string",
"managedServiceIdentities": [{"name": null,
"example": null
}
],
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"network": {"virtualNetworkName": "vname",
"subnetName": "my-subnet-name",
"resourceGroupName": "subnetResourceGroup",
"assignPublicIp": null,
"additionalIpConfigurations": [{"name": "config1",
"privateIpAddressVersion": "IPv4"
}
]
},
"extensions": [{"autoUpgradeMinorVersion": true,
"name": "k8s-agentpool1-38611891-vmss-computeAksLinuxBilling",
"protectedSettings": null,
"publisher": "Microsoft.AKS",
"type": "Compute.AKS-Engine.Linux.Billing",
"typeHandlerVersion": "1.0"
}
],
"customData": "string",
"login": {"userName": "spotinst",
"sshPublicKey": "string",
"password": "string"
}
}
},
"thirdPartiesIntegration": {"kubernetes": {"clusterIdentifier": "aks-engine-cluser"
},
"hpcGridEngine": {"clusterId": "spotinst-uge-cluster",
"queues": [{"name": "burst.q"
}
],
"distribution": "sge",
"tortuga": {"softwareProfile": "execd",
"hardwareProfile": "execd-elastigroup"
}
}
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"group": {"id": "sig-123456789",
"name": "spotinst-group",
"region": "eastus",
"resourceGroupName": "spotinst-azure",
"capacity": {"target": 8,
"minimum": 2,
"maximum": 10
},
"scaling": {"up": [{"policyName": "cpuScaleUp",
"metricName": "Percentage CPU",
"statistic": "average",
"threshold": 0.75,
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"namespace": "Microsoft.Network/applicationGateways",
"operator": "gte",
"dimenstions": [{"name": "resourceName",
"value": "TestAppGateway"
}
],
"action": {"type": "adjustment",
"adjustment": "2"
}
}
],
"down": [{"policyName": "cpuScaleDown",
"metricName": "Percentage CPU",
"statistic": "average",
"threshold": 0.25,
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"namespace": "Microsoft.Network/applicationGateways",
"operator": "lte",
"dimenstions": [{"name": "resourceName",
"value": "TestAppGateway"
}
],
"action": {"type": "adjustment",
"adjustment": "2"
}
}
]
},
"strategy": {"lowPriorityPercentage": 0,
"odCount": 0,
"drainingTimeout": 0
},
"compute": {"vmSizes": {"odSizes": ["standard_a1_v1"
],
"lowPrioritySizes": ["standard_a2_v2"
]
},
"product": "Linux",
"health": {"autoHealing": true,
"healthCheckType": "INSTANCE_STATE",
"gracePeriod": 120
},
"launchSpecification": {"image": {"marketplace": {"publisher": "OpenLogic",
"offer": "CentOS",
"sku": "7.3",
"version": "7.3-1611"
},
"shutdownScript": "IyEvdXNyL2Jpbi9lbnYgYmFzaAoiR29vZGJ5ZSBvbGQgaW5zdGFuY2Ui",
"custom": {"resourceGroupName": "spotinst-azure",
"imageName": "custom-image-name"
}
},
"loadBalancersConfig": {"loadBalancers": [{"type": "MULTAI_TARGET_SET",
"balancerId": "lb-1ee2e3q",
"targetSetId": "ts-3eq",
"autoWeight": true
}
]
},
"userData": "string",
"managedServiceIdentities": [{"name": null,
"example": null
}
],
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"network": {"virtualNetworkName": "vname",
"subnetName": "my-subnet-name",
"resourceGroupName": "subnetResourceGroup",
"assignPublicIp": null,
"additionalIpConfigurations": [{"name": "config1",
"privateIpAddressVersion": "IPv4"
}
]
},
"extensions": [{"autoUpgradeMinorVersion": true,
"name": "k8s-agentpool1-38611891-vmss-computeAksLinuxBilling",
"protectedSettings": null,
"publisher": "Microsoft.AKS",
"type": "Compute.AKS-Engine.Linux.Billing",
"typeHandlerVersion": "1.0"
}
],
"customData": "string",
"login": {"userName": "spotinst",
"sshPublicKey": "string",
"password": "string"
}
}
},
"thirdPartiesIntegration": {"kubernetes": {"clusterIdentifier": "aks-engine-cluser"
},
"hpcGridEngine": {"clusterId": "spotinst-uge-cluster",
"queues": [{"name": "burst.q"
}
],
"distribution": "sge",
"tortuga": {"softwareProfile": "execd",
"hardwareProfile": "execd-elastigroup"
}
}
}
}
}
],
"count": 1,
"kind": "string"
}
}

Delete Task

Delete an Elastigroup Azure

Authorizations:

path Parameters

groupId

required

string

Example: sig-12345

Elastigroup ID

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Update Task

Update an Elastigroup Azure

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

required

object

	object
	object
name required	string Azure Elastigroup Name
region	string Valid Azure region the Elastigroup is managed in
resourceGroupName	string The Azure resource group to associate the Elastigroup with
	object (Azure Scaling)
	object (Scaling Strategy)
	object

Responses

Request samples

Payload

Content type

application/json

{"group": {"name": "spotinst-group",
"region": "eastus",
"resourceGroupName": "spotinst-azure",
"capacity": {"target": 8,
"minimum": 2,
"maximum": 10
},
"scaling": {"up": [{"policyName": "cpuScaleUp",
"metricName": "Percentage CPU",
"statistic": "average",
"threshold": 0.75,
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"namespace": "Microsoft.Network/applicationGateways",
"operator": "gte",
"dimenstions": [{"name": "resourceName",
"value": "TestAppGateway"
}
],
"action": {"type": "adjustment",
"adjustment": "2"
}
}
],
"down": [{"policyName": "cpuScaleDown",
"metricName": "Percentage CPU",
"statistic": "average",
"threshold": 0.25,
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"namespace": "Microsoft.Network/applicationGateways",
"operator": "lte",
"dimenstions": [{"name": "resourceName",
"value": "TestAppGateway"
}
],
"action": {"type": "adjustment",
"adjustment": "2"
}
}
]
},
"strategy": {"lowPriorityPercentage": 0,
"odCount": 0,
"drainingTimeout": 0
},
"compute": {"vmSizes": {"odSizes": ["standard_a1_v1"
],
"lowPrioritySizes": ["standard_a2_v2"
]
},
"product": "Linux",
"health": {"autoHealing": true,
"healthCheckType": "INSTANCE_STATE",
"gracePeriod": 120
},
"launchSpecification": {"image": {"marketplace": {"publisher": "OpenLogic",
"offer": "CentOS",
"sku": "7.3",
"version": "7.3-1611"
},
"shutdownScript": "IyEvdXNyL2Jpbi9lbnYgYmFzaAoiR29vZGJ5ZSBvbGQgaW5zdGFuY2Ui",
"custom": {"resourceGroupName": "spotinst-azure",
"imageName": "custom-image-name"
}
},
"loadBalancersConfig": {"loadBalancers": [{"type": "MULTAI_TARGET_SET",
"balancerId": "lb-1ee2e3q",
"targetSetId": "ts-3eq",
"autoWeight": true
}
]
},
"userData": "string",
"managedServiceIdentities": [{"name": null,
"example": null
}
],
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"network": {"virtualNetworkName": "vname",
"subnetName": "my-subnet-name",
"resourceGroupName": "subnetResourceGroup",
"assignPublicIp": null,
"additionalIpConfigurations": [{"name": "config1",
"privateIpAddressVersion": "IPv4"
}
]
},
"extensions": [{"autoUpgradeMinorVersion": true,
"name": "k8s-agentpool1-38611891-vmss-computeAksLinuxBilling",
"protectedSettings": null,
"publisher": "Microsoft.AKS",
"type": "Compute.AKS-Engine.Linux.Billing",
"typeHandlerVersion": "1.0"
}
],
"customData": "string",
"login": {"userName": "spotinst",
"sshPublicKey": "string",
"password": "string"
}
}
},
"thirdPartiesIntegration": {"kubernetes": {"clusterIdentifier": "aks-engine-cluser"
},
"hpcGridEngine": {"clusterId": "spotinst-uge-cluster",
"queues": [{"name": "burst.q"
}
],
"distribution": "sge",
"tortuga": {"softwareProfile": "execd",
"hardwareProfile": "execd-elastigroup"
}
}
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"group": {"id": "sig-123456789",
"name": "spotinst-group",
"region": "eastus",
"resourceGroupName": "spotinst-azure",
"capacity": {"target": 8,
"minimum": 2,
"maximum": 10
},
"scaling": {"up": [{"policyName": "cpuScaleUp",
"metricName": "Percentage CPU",
"statistic": "average",
"threshold": 0.75,
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"namespace": "Microsoft.Network/applicationGateways",
"operator": "gte",
"dimenstions": [{"name": "resourceName",
"value": "TestAppGateway"
}
],
"action": {"type": "adjustment",
"adjustment": "2"
}
}
],
"down": [{"policyName": "cpuScaleDown",
"metricName": "Percentage CPU",
"statistic": "average",
"threshold": 0.25,
"period": 60,
"evaluationPeriods": 3,
"cooldown": 300,
"namespace": "Microsoft.Network/applicationGateways",
"operator": "lte",
"dimenstions": [{"name": "resourceName",
"value": "TestAppGateway"
}
],
"action": {"type": "adjustment",
"adjustment": "2"
}
}
]
},
"strategy": {"lowPriorityPercentage": 0,
"odCount": 0,
"drainingTimeout": 0
},
"compute": {"vmSizes": {"odSizes": ["standard_a1_v1"
],
"lowPrioritySizes": ["standard_a2_v2"
]
},
"product": "Linux",
"health": {"autoHealing": true,
"healthCheckType": "INSTANCE_STATE",
"gracePeriod": 120
},
"launchSpecification": {"image": {"marketplace": {"publisher": "OpenLogic",
"offer": "CentOS",
"sku": "7.3",
"version": "7.3-1611"
},
"shutdownScript": "IyEvdXNyL2Jpbi9lbnYgYmFzaAoiR29vZGJ5ZSBvbGQgaW5zdGFuY2Ui",
"custom": {"resourceGroupName": "spotinst-azure",
"imageName": "custom-image-name"
}
},
"loadBalancersConfig": {"loadBalancers": [{"type": "MULTAI_TARGET_SET",
"balancerId": "lb-1ee2e3q",
"targetSetId": "ts-3eq",
"autoWeight": true
}
]
},
"userData": "string",
"managedServiceIdentities": [{"name": null,
"example": null
}
],
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"network": {"virtualNetworkName": "vname",
"subnetName": "my-subnet-name",
"resourceGroupName": "subnetResourceGroup",
"assignPublicIp": null,
"additionalIpConfigurations": [{"name": "config1",
"privateIpAddressVersion": "IPv4"
}
]
},
"extensions": [{"autoUpgradeMinorVersion": true,
"name": "k8s-agentpool1-38611891-vmss-computeAksLinuxBilling",
"protectedSettings": null,
"publisher": "Microsoft.AKS",
"type": "Compute.AKS-Engine.Linux.Billing",
"typeHandlerVersion": "1.0"
}
],
"customData": "string",
"login": {"userName": "spotinst",
"sshPublicKey": "string",
"password": "string"
}
}
},
"thirdPartiesIntegration": {"kubernetes": {"clusterIdentifier": "aks-engine-cluser"
},
"hpcGridEngine": {"clusterId": "spotinst-uge-cluster",
"queues": [{"name": "burst.q"
}
],
"distribution": "sge",
"tortuga": {"softwareProfile": "execd",
"hardwareProfile": "execd-elastigroup"
}
}
}
}
}
],
"count": 1,
"kind": "string"
}
}

Get Costs Per Account

Get costs per time filter.

Authorizations:

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
required	unix (string) or dateTime (string) Example: fromDate=2020-09-01 or fromDate=1598918400000 Get items on or after this date (ISO 8601 or Unix timestamp)
required	unix (string) or dateTime (string) Example: toDate=2020-09-01 or toDate=1598918400000 Get items on or before this date (ISO 8601 or Unix timestamp)

Responses

Response samples

Content type

application/json

{"request": {"id": "67582d0c-108b-4ef7-9fdc-d39678a30844",
"url": "/azure/costs",
"method": "GET",
"timestamp": "2018-01-07T07:30:58.622Z"
},
"response": {"kind": "spotinst:azure:costs",
"items": [{"lowPriority": {"runningHours": 1470.8,
"actualCosts": 107.3,
"potentialCosts": 378.41,
"savingsPercentage": 71.64
}
}
],
"count": 1
}
}

Elastigroup Azure Stateful

Elastigroup for Microsoft Azure Stateful Node

Create Stateful Node

Create a new stateful node.

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

object (Azure Stateful Node)

required	object (Stateful Node Compute) Defines the computational parameters to use when launch the VM for the Stateful Node.
description	string The description for the Stateful Node.
	object (Stateful Node Health) Set the auto healing preferences for unhealthy VMs.
name required	string Stateful Node Name.
required	object (Stateful Node Persistence) Defines the persistence of the Stateful Node.
region required	string The Azure region in which the Stateful Node will be launched.
resourceGroupName required	string The Azure resource group in which the VM and all of the subsequent subresources will be launched.
	object (Stateful Node Scheduling) Scheduling settings for stateful node.
required	object (Stateful Node Strategy) The strategy to launch the underlying VM and Spot’s behavior for the Stateful Node.

Responses

Request samples

Payload

Content type

application/json

{"statefulNode": {"name": "Spot Stateful Node",
"region": "westus2",
"resourceGroupName": "spotResourceGroup",
"description": "This is my example stateful node",
"strategy": {"preferredLifecycle": "od",
"signals": [{"type": "vmReady",
"timeout": 180
}
],
"fallbackToOd": true,
"drainingTimeout": 30,
"revertToSpot": {"performAt": "timeWindow"
},
"optimizationWindows": ["Mon:03:00-Wed:02:30"
]
},
"compute": {"os": "Linux",
"vmSizes": {"odSizes": ["standard_a1_v1"
],
"spotSizes": ["standard_a2_v2"
],
"preferredSpotSizes": ["standard_a2_v2"
]
},
"zones": ["1"
],
"preferredZone": "1",
"launchSpecification": {"image": {"marketplace": {"publisher": "OpenLogic",
"offer": "CentOS",
"sku": "7.3",
"version": "7.3-1611"
},
"custom": {"resourceGroupName": "spotinst-azure",
"name": "custom-image-name"
},
"gallery": {"resourceGroupName": "spotinst-azure",
"galleryName": "gallery-name",
"imageName": "gallery-image-name",
"versionName": "0.0.1"
}
},
"vmNamePrefix": "prefix",
"customData": "",
"shutdownScript": "IyEvdXNyL2Jpbi9lbnYgYmFzaAoiR29vZGJ5ZSBvbGQgaW5zdGFuY2Ui",
"network": {"resourceGroupName": "subnetResourceGroup",
"virtualNetworkName": "vname",
"networkInterfaces": [{"isPrimary": true,
"subnetName": "testSubnet",
"assignPublicIp": true,
"publicIpSku": "Standard",
"networkSecurityGroup": {"name": "test",
"resourceGroupName": "test"
},
"enableIPForwarding": true,
"privateIpAddresses": [["172.23.4.20"
]
],
"additionalIpConfigurations": [{"name": "test",
"privateIpAddressVersion": "IPv4"
}
],
"publicIps": [{"resourceGroupName": "resourceGroup",
"name": "name"
}
],
"applicationSecurityGroups": [{"resourceGroupName": "AsgResourceGroup",
"name": "AsgName"
}
]
}
]
},
"login": {"userName": "spotinst",
"sshPublicKey": "ssh-rsa",
"password": "string"
},
"loadBalancersConfig": {"loadBalancers": [{"type": "loadBalancer",
"resourceGroupName": "testResourceGroup",
"name": "testLoadBalancer",
"loadBalancerSku": "Standard",
"backendPoolNames": ["testBackendPool1",
"testBackendPool2"
]
}
]
},
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"managedServiceIdentities": [{"name": "mySI2",
"resourceGroupName": "myResourceGroup"
}
],
"extensions": [{"name": "extensionName",
"type": "customScript",
"publisher": "Microsoft.Azure.Extensions",
"apiVersion": "2.0",
"minorVersionAutoUpgrade": true,
"publicSettings": { },
"protectedSettings": { }
}
],
"dataDisks": [{"sizeGB": 1,
"lun": 1,
"type": "Standard_LRS"
}
],
"osDisk": {"type": "Standard_LRS",
"sizeGB": 30
},
"secrets": [{"sourceVault": {"resourceGroupName": "string",
"name": "string"
},
"vaultCertificates": [{"certificateUrl": "string",
"certificateStore": "string"
}
]
}
],
"bootDiagnostics": {"isEnabled": true,
"type": "managed",
"storageUri": "https://example.blob.core.windows.net/"
}
}
},
"persistence": {"shouldPersistOsDisk": true,
"osDiskPersistenceMode": "onLaunch",
"shouldPersistDataDisks": true,
"dataDisksPersistenceMode": "reattach",
"shouldPersistNetwork": true
},
"scheduling": {"tasks": [{"isEnabled": true,
"type": "recycle",
"cronExpression": "35 12 * * *"
}
]
},
"health": {"healthCheckTypes": ["vmState"
],
"gracePeriod": 120,
"autoHealing": true,
"unhealthyDuration": 360
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/azure/compute/statefulNode/ssn-12345678",
"method": "POST",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "ssn-12345678",
"name": "Spot Stateful Node",
"region": "westus2",
"resourceGroupName": "spotResourceGroup",
"description": "This is my example stateful node",
"strategy": {"preferredLifecycle": "od",
"signals": [{"type": "vmReady",
"timeout": 180
}
],
"fallbackToOd": true,
"drainingTimeout": 30,
"revertToSpot": {"performAt": "timeWindow"
},
"optimizationWindows": ["Mon:03:00-Wed:02:30"
]
},
"compute": {"os": "Linux",
"vmSizes": {"odSizes": ["standard_a1_v1"
],
"spotSizes": ["standard_a2_v2"
],
"preferredSpotSizes": ["standard_a2_v2"
]
},
"zones": ["1"
],
"preferredZone": "1",
"launchSpecification": {"image": {"marketplace": {"publisher": "OpenLogic",
"offer": "CentOS",
"sku": "7.3",
"version": "7.3-1611"
},
"custom": {"resourceGroupName": "spotinst-azure",
"name": "custom-image-name"
},
"gallery": {"resourceGroupName": "spotinst-azure",
"galleryName": "gallery-name",
"imageName": "gallery-image-name",
"versionName": "0.0.1"
}
},
"vmNamePrefix": "prefix",
"customData": "",
"network": {"resourceGroupName": "subnetResourceGroup",
"virtualNetworkName": "vname",
"networkInterfaces": [{"isPrimary": true,
"subnetName": "testSubnet",
"assignPublicIp": true,
"publicIpSku": "Standard",
"networkSecurityGroup": {"name": "test",
"resourceGroupName": "test"
},
"enableIPForwarding": true,
"privateIpAddresses": [["172.23.4.20"
]
],
"additionalIpConfigurations": [{"name": "test",
"privateIpAddressVersion": "IPv4"
}
],
"publicIps": [{"resourceGroupName": "resourceGroup",
"name": "name"
}
],
"applicationSecurityGroups": [{"resourceGroupName": "AsgResourceGroup",
"name": "AsgName"
}
]
}
]
},
"login": {"userName": "spotinst",
"sshPublicKey": "ssh-rsa"
},
"loadBalancersConfig": {"loadBalancers": [{"type": "loadBalancer",
"resourceGroupName": "testResourceGroup",
"name": "testLoadBalancer",
"loadBalancerSku": "Standard",
"backendPoolNames": ["testBackendPool1",
"testBackendPool2"
]
}
]
},
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"extensions": [{"name": "extensionName",
"type": "customScript",
"publisher": "Microsoft.Azure.Extensions",
"apiVersion": "2.0",
"minorVersionAutoUpgrade": true,
"publicSettings": { },
"protectedSettings": { }
}
],
"dataDisks": [{"sizeGB": 1,
"lun": 1,
"type": "Standard_LRS"
}
],
"osDisk": {"type": "Standard_LRS",
"sizeGB": 30
},
"secrets": [{"sourceVault": {"resourceGroupName": "string",
"name": "string"
},
"vaultCertificates": [{"certificateUrl": "string",
"certificateStore": "string"
}
]
}
],
"bootDiagnostics": {"isEnabled": true,
"type": "managed",
"storageUri": "https://example.blob.core.windows.net/"
}
}
},
"persistence": {"shouldPersistOsDisk": true,
"osDiskPersistenceMode": "onLaunch",
"shouldPersistDataDisks": true,
"dataDisksPersistenceMode": "reattach",
"shouldPersistNetwork": true
},
"scheduling": {"tasks": [{"isEnabled": true,
"type": "recycle",
"cronExpression": "35 12 * * *"
}
]
},
"health": {"healthCheckTypes": ["vmState"
],
"gracePeriod": 120,
"autoHealing": true,
"unhealthyDuration": 360
},
"createdAt": "2022-01-01T00:00:00.000+0000",
"updatedAt": "2022-01-01T00:00:00.000+0000"
}
],
"count": 1,
"kind": "spotinst:azure:statefulNode"
}
}

Get All Stateful Nodes

Get the configurations of all stateful nodes in a specific account.

Authorizations:

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
name	string Example: name=MyStatefulGroup Filters to find the stateful node via a specific name.
region	string Example: region=eastus Filters to find all the stateful nodes in a specific region.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/azure/compute/statefulNode",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "ssn-12345678",
"name": "Spot Stateful Node",
"region": "westus2",
"resourceGroupName": "spotResourceGroup",
"description": "This is my example stateful node",
"strategy": {"preferredLifecycle": "od",
"signals": [{"type": "vmReady",
"timeout": 180
}
],
"fallbackToOd": true,
"drainingTimeout": 30,
"revertToSpot": {"performAt": "timeWindow"
},
"optimizationWindows": ["Mon:03:00-Wed:02:30"
]
},
"compute": {"os": "Linux",
"vmSizes": {"odSizes": ["standard_a1_v1"
],
"spotSizes": ["standard_a2_v2"
],
"preferredSpotSizes": ["standard_a2_v2"
]
},
"zones": ["1"
],
"preferredZone": "1",
"launchSpecification": {"image": {"marketplace": {"publisher": "OpenLogic",
"offer": "CentOS",
"sku": "7.3",
"version": "7.3-1611"
},
"custom": {"resourceGroupName": "spotinst-azure",
"name": "custom-image-name"
},
"gallery": {"resourceGroupName": "spotinst-azure",
"galleryName": "gallery-name",
"imageName": "gallery-image-name",
"versionName": "0.0.1"
}
},
"vmNamePrefix": "prefix",
"customData": "",
"network": {"resourceGroupName": "subnetResourceGroup",
"virtualNetworkName": "vname",
"networkInterfaces": [{"isPrimary": true,
"subnetName": "testSubnet",
"assignPublicIp": true,
"publicIpSku": "Standard",
"networkSecurityGroup": {"name": "test",
"resourceGroupName": "test"
},
"enableIPForwarding": true,
"privateIpAddresses": [["172.23.4.20"
]
],
"additionalIpConfigurations": [{"name": "test",
"privateIpAddressVersion": "IPv4"
}
],
"publicIps": [{"resourceGroupName": "resourceGroup",
"name": "name"
}
],
"applicationSecurityGroups": [{"resourceGroupName": "AsgResourceGroup",
"name": "AsgName"
}
]
}
]
},
"login": {"userName": "spotinst",
"sshPublicKey": "ssh-rsa"
},
"loadBalancersConfig": {"loadBalancers": [{"type": "loadBalancer",
"resourceGroupName": "testResourceGroup",
"name": "testLoadBalancer",
"loadBalancerSku": "Standard",
"backendPoolNames": ["testBackendPool1",
"testBackendPool2"
]
}
]
},
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"extensions": [{"name": "extensionName",
"type": "customScript",
"publisher": "Microsoft.Azure.Extensions",
"apiVersion": "2.0",
"minorVersionAutoUpgrade": true,
"publicSettings": { },
"protectedSettings": { }
}
],
"dataDisks": [{"sizeGB": 1,
"lun": 1,
"type": "Standard_LRS"
}
],
"osDisk": {"type": "Standard_LRS",
"sizeGB": 30
},
"secrets": [{"sourceVault": {"resourceGroupName": "string",
"name": "string"
},
"vaultCertificates": [{"certificateUrl": "string",
"certificateStore": "string"
}
]
}
],
"bootDiagnostics": {"isEnabled": true,
"type": "managed",
"storageUri": "https://example.blob.core.windows.net/"
}
}
},
"persistence": {"shouldPersistOsDisk": true,
"osDiskPersistenceMode": "onLaunch",
"shouldPersistDataDisks": true,
"dataDisksPersistenceMode": "reattach",
"shouldPersistNetwork": true
},
"scheduling": {"tasks": [{"isEnabled": true,
"type": "recycle",
"cronExpression": "35 12 * * *"
}
]
},
"health": {"healthCheckTypes": ["vmState"
],
"gracePeriod": 120,
"autoHealing": true,
"unhealthyDuration": 360
},
"createdAt": "2022-01-01T00:00:00.000+0000",
"updatedAt": "2022-01-01T00:00:00.000+0000"
}
],
"count": 1,
"kind": "spotinst:azure:statefulNode"
}
}

Get Stateful Node

Get the configuration of an existing stateful node.

Authorizations:

path Parameters

nodeId

required

string

Example: ssn-12345678

The ID of the stateful node.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/azure/compute/statefulNode/ssn-12345678",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "ssn-12345678",
"name": "Spot Stateful Node",
"region": "westus2",
"resourceGroupName": "spotResourceGroup",
"description": "This is my example stateful node",
"strategy": {"preferredLifecycle": "od",
"signals": [{"type": "vmReady",
"timeout": 180
}
],
"fallbackToOd": true,
"drainingTimeout": 30,
"revertToSpot": {"performAt": "timeWindow"
},
"optimizationWindows": ["Mon:03:00-Wed:02:30"
]
},
"compute": {"os": "Linux",
"vmSizes": {"odSizes": ["standard_a1_v1"
],
"spotSizes": ["standard_a2_v2"
],
"preferredSpotSizes": ["standard_a2_v2"
]
},
"zones": ["1"
],
"preferredZone": "1",
"launchSpecification": {"image": {"marketplace": {"publisher": "OpenLogic",
"offer": "CentOS",
"sku": "7.3",
"version": "7.3-1611"
},
"custom": {"resourceGroupName": "spotinst-azure",
"name": "custom-image-name"
},
"gallery": {"resourceGroupName": "spotinst-azure",
"galleryName": "gallery-name",
"imageName": "gallery-image-name",
"versionName": "0.0.1"
}
},
"vmNamePrefix": "prefix",
"customData": "",
"network": {"resourceGroupName": "subnetResourceGroup",
"virtualNetworkName": "vname",
"networkInterfaces": [{"isPrimary": true,
"subnetName": "testSubnet",
"assignPublicIp": true,
"publicIpSku": "Standard",
"networkSecurityGroup": {"name": "test",
"resourceGroupName": "test"
},
"enableIPForwarding": true,
"privateIpAddresses": [["172.23.4.20"
]
],
"additionalIpConfigurations": [{"name": "test",
"privateIpAddressVersion": "IPv4"
}
],
"publicIps": [{"resourceGroupName": "resourceGroup",
"name": "name"
}
],
"applicationSecurityGroups": [{"resourceGroupName": "AsgResourceGroup",
"name": "AsgName"
}
]
}
]
},
"login": {"userName": "spotinst",
"sshPublicKey": "ssh-rsa"
},
"loadBalancersConfig": {"loadBalancers": [{"type": "loadBalancer",
"resourceGroupName": "testResourceGroup",
"name": "testLoadBalancer",
"loadBalancerSku": "Standard",
"backendPoolNames": ["testBackendPool1",
"testBackendPool2"
]
}
]
},
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"extensions": [{"name": "extensionName",
"type": "customScript",
"publisher": "Microsoft.Azure.Extensions",
"apiVersion": "2.0",
"minorVersionAutoUpgrade": true,
"publicSettings": { },
"protectedSettings": { }
}
],
"dataDisks": [{"sizeGB": 1,
"lun": 1,
"type": "Standard_LRS"
}
],
"osDisk": {"type": "Standard_LRS",
"sizeGB": 30
},
"secrets": [{"sourceVault": {"resourceGroupName": "string",
"name": "string"
},
"vaultCertificates": [{"certificateUrl": "string",
"certificateStore": "string"
}
]
}
],
"bootDiagnostics": {"isEnabled": true,
"type": "managed",
"storageUri": "https://example.blob.core.windows.net/"
}
}
},
"persistence": {"shouldPersistOsDisk": true,
"osDiskPersistenceMode": "onLaunch",
"shouldPersistDataDisks": true,
"dataDisksPersistenceMode": "reattach",
"shouldPersistNetwork": true
},
"scheduling": {"tasks": [{"isEnabled": true,
"type": "recycle",
"cronExpression": "35 12 * * *"
}
]
},
"health": {"healthCheckTypes": ["vmState"
],
"gracePeriod": 120,
"autoHealing": true,
"unhealthyDuration": 360
},
"createdAt": "2022-01-01T00:00:00.000+0000",
"updatedAt": "2022-01-01T00:00:00.000+0000"
}
],
"count": 1,
"kind": "spotinst:azure:statefulNode"
}
}

Update Stateful Node

Update an existing stateful node.

Authorizations:

path Parameters

nodeId

required

string

Example: ssn-12345678

The ID of the stateful node.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

object (Azure Stateful Node)

	object (Stateful Node Compute) Compute settings for Stateful Node
description	string Describe your Azure Stateful Node
	object (Stateful Node Health) Autohealing of unhealthy VM.
name	string Azure Stateful Node Name
	object (Stateful Node Persistence) Persistence settings for stateful node
	object (Stateful Node Scheduling) Scheduling settings for stateful node
	object (Stateful Node Strategy) Strategy for Stateful Node.

Responses

Request samples

Payload

Content type

application/json

{"statefulNode": {"name": "Spot Stateful Node",
"description": "This is my example stateful node",
"strategy": {"preferredLifecycle": "od",
"signals": [{"type": "vmReady",
"timeout": 180
}
],
"fallbackToOd": true,
"drainingTimeout": 30,
"revertToSpot": {"performAt": "timeWindow"
},
"optimizationWindows": ["Mon:03:00-Wed:02:30"
]
},
"compute": {"os": "Linux",
"vmSizes": {"odSizes": ["standard_a1_v1"
],
"spotSizes": ["standard_a2_v2"
],
"preferredSpotSizes": ["standard_a2_v2"
]
},
"zones": ["1"
],
"preferredZone": "1",
"launchSpecification": {"image": {"marketplace": {"publisher": "OpenLogic",
"offer": "CentOS",
"sku": "7.3",
"version": "7.3-1611"
},
"custom": {"resourceGroupName": "spotinst-azure",
"name": "custom-image-name"
},
"gallery": {"resourceGroupName": "spotinst-azure",
"galleryName": "gallery-name",
"imageName": "gallery-image-name",
"versionName": "0.0.1"
}
},
"vmNamePrefix": "prefix",
"customData": "",
"shutdownScript": "IyEvdXNyL2Jpbi9lbnYgYmFzaAoiR29vZGJ5ZSBvbGQgaW5zdGFuY2Ui",
"network": {"resourceGroupName": "subnetResourceGroup",
"virtualNetworkName": "vname",
"networkInterfaces": [{"isPrimary": true,
"subnetName": "testSubnet",
"assignPublicIp": true,
"publicIpSku": "STANDARD",
"networkSecurityGroup": {"name": "test",
"resourceGroupName": "test"
},
"enableIPForwarding": true,
"privateIpAddresses": [["172.23.4.20"
]
],
"additionalIpConfigurations": [{"name": "test",
"privateIpAddressVersion": "IPv4"
}
],
"publicIps": [{"resourceGroupName": "resourceGroup",
"name": "name"
}
],
"applicationSecurityGroups": [{"resourceGroupName": "AsgResourceGroup",
"name": "AsgName"
}
]
}
]
},
"login": {"userName": "spotinst",
"sshPublicKey": "ssh-rsa",
"password": "string"
},
"loadBalancersConfig": {"loadBalancers": [{"type": "loadBalancer",
"resourceGroupName": "testResourceGroup",
"name": "testLoadBalancer",
"loadBalancerSku": "Standard",
"backendPoolNames": ["testBackendPool1",
"testBackendPool2"
]
}
]
},
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"managedServiceIdentities": [{"name": "mySI2",
"resourceGroupName": "myResourceGroup"
}
],
"extensions": [{"name": "extensionName",
"type": "customScript",
"publisher": "Microsoft.Azure.Extensions",
"apiVersion": "2.0",
"minorVersionAutoUpgrade": true,
"publicSettings": { },
"protectedSettings": { }
}
],
"dataDisks": [{"sizeGB": 1,
"lun": 1,
"type": "Standard_LRS"
}
],
"osDisk": {"type": "Standard_LRS",
"sizeGB": 30
},
"secrets": [{"sourceVault": {"resourceGroupName": "string",
"name": "string"
},
"vaultCertificates": [{"certificateUrl": "string",
"certificateStore": "string"
}
]
}
],
"bootDiagnostics": {"isEnabled": true,
"type": "managed",
"storageUri": "https://example.blob.core.windows.net/"
}
}
},
"persistence": {"shouldPersistOsDisk": true,
"osDiskPersistenceMode": "onLaunch",
"shouldPersistDataDisks": true,
"dataDisksPersistenceMode": "reattach",
"shouldPersistNetwork": true
},
"scheduling": {"tasks": [{"isEnabled": true,
"type": "recycle",
"cronExpression": "35 12 * * *"
}
]
},
"health": {"healthCheckTypes": ["vmState"
],
"gracePeriod": 120,
"autoHealing": true,
"unhealthyDuration": 360
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/azure/compute/statefulNode/ssn-12345678",
"method": "UPDATE",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "ssn-12345678",
"name": "Spot Stateful Node",
"region": "westus2",
"resourceGroupName": "spotResourceGroup",
"description": "This is my example stateful node",
"strategy": {"preferredLifecycle": "od",
"signals": [{"type": "vmReady",
"timeout": 180
}
],
"fallbackToOd": true,
"drainingTimeout": 30,
"revertToSpot": {"performAt": "timeWindow"
},
"optimizationWindows": ["Mon:03:00-Wed:02:30"
]
},
"compute": {"os": "Linux",
"vmSizes": {"odSizes": ["standard_a1_v1"
],
"spotSizes": ["standard_a2_v2"
],
"preferredSpotSizes": ["standard_a2_v2"
]
},
"zones": ["1"
],
"preferredZone": "1",
"launchSpecification": {"image": {"marketplace": {"publisher": "OpenLogic",
"offer": "CentOS",
"sku": "7.3",
"version": "7.3-1611"
},
"custom": {"resourceGroupName": "spotinst-azure",
"name": "custom-image-name"
},
"gallery": {"resourceGroupName": "spotinst-azure",
"galleryName": "gallery-name",
"imageName": "gallery-image-name",
"versionName": "0.0.1"
}
},
"vmNamePrefix": "prefix",
"customData": "",
"network": {"resourceGroupName": "subnetResourceGroup",
"virtualNetworkName": "vname",
"networkInterfaces": [{"isPrimary": true,
"subnetName": "testSubnet",
"assignPublicIp": true,
"publicIpSku": "Standard",
"networkSecurityGroup": {"name": "test",
"resourceGroupName": "test"
},
"enableIPForwarding": true,
"privateIpAddresses": [["172.23.4.20"
]
],
"additionalIpConfigurations": [{"name": "test",
"privateIpAddressVersion": "IPv4"
}
],
"publicIps": [{"resourceGroupName": "resourceGroup",
"name": "name"
}
],
"applicationSecurityGroups": [{"resourceGroupName": "AsgResourceGroup",
"name": "AsgName"
}
]
}
]
},
"login": {"userName": "spotinst",
"sshPublicKey": "ssh-rsa"
},
"loadBalancersConfig": {"loadBalancers": [{"type": "loadBalancer",
"resourceGroupName": "testResourceGroup",
"name": "testLoadBalancer",
"loadBalancerSku": "Standard",
"backendPoolNames": ["testBackendPool1",
"testBackendPool2"
]
}
]
},
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"extensions": [{"name": "extensionName",
"type": "customScript",
"publisher": "Microsoft.Azure.Extensions",
"apiVersion": "2.0",
"minorVersionAutoUpgrade": true,
"publicSettings": { },
"protectedSettings": { }
}
],
"dataDisks": [{"sizeGB": 1,
"lun": 1,
"type": "Standard_LRS"
}
],
"osDisk": {"type": "Standard_LRS",
"sizeGB": 30
},
"secrets": [{"sourceVault": {"resourceGroupName": "string",
"name": "string"
},
"vaultCertificates": [{"certificateUrl": "string",
"certificateStore": "string"
}
]
}
],
"bootDiagnostics": {"isEnabled": true,
"type": "managed",
"storageUri": "https://example.blob.core.windows.net/"
}
}
},
"persistence": {"shouldPersistOsDisk": true,
"osDiskPersistenceMode": "onLaunch",
"shouldPersistDataDisks": true,
"dataDisksPersistenceMode": "reattach",
"shouldPersistNetwork": true
},
"scheduling": {"tasks": [{"isEnabled": true,
"type": "recycle",
"cronExpression": "35 12 * * *"
}
]
},
"health": {"healthCheckTypes": ["vmState"
],
"gracePeriod": 120,
"autoHealing": true,
"unhealthyDuration": 360
},
"createdAt": "2022-01-01T00:00:00.000+0000",
"updatedAt": "2022-01-01T00:00:00.000+0000"
}
],
"count": 1,
"kind": "spotinst:azure:statefulNode"
}
}

Delete Stateful Node

Delete an existing stateful node from the account.

Authorizations:

path Parameters

nodeId

required

string

Example: ssn-12345678

The ID of the stateful node.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

object (Delete Azure Stateful Node Configuration)

	object (Disk Deallocation Config) Disk Deallocation Configuration.
	object (Network Deallocation Config) Network Deallocation Configuration.
	object (Public IP Deallocation Config) Public IP Deallocation Configuration.
shouldTerminateVm required	boolean Indicates whether to delete the stateful node's VM.
	object (Snapshot Deallocation Config) Snapshot Deallocation Configuration.

Responses

Request samples

Payload

Content type

application/json

{"deallocationConfig": {"shouldTerminateVm": true,
"networkDeallocationConfig": {"shouldDeallocate": true,
"ttlInHours": 1
},
"diskDeallocationConfig": {"shouldDeallocate": true,
"ttlInHours": 1
},
"snapshotDeallocationConfig": {"shouldDeallocate": true,
"ttlInHours": 1
},
"publicIpDeallocationConfig": {"shouldDeallocate": true,
"ttlInHours": 1
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/azure/compute/statefulNode/ssn-12345678",
"method": "DELETE",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [ ],
"count": 1,
"kind": "string"
}
}

Get Stateful Node Resources

Get the node's attached resources (storage and network interfaces).

Authorizations:

path Parameters

nodeId

required

string

Example: ssn-12345678

The ID of the stateful node.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/azure/compute/statefulNode/ssn-12345678/resources",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "ssn-12345678",
"name": "MyStatefulNode",
"resourceGroupName": "dataDiskResourceGroup",
"network": {"virtualNetwork": {"name": "MyVirtualNetwork",
"resourceGroupName": "virtualNetworkResourceGroup"
},
"networkInterfaces": [{"name": "MyNetworkInterface",
"resourceGroupName": "networkInterfaceResourceGroup",
"isPrimary": true,
"networkSecurityGroup": {"name": "MyNetworkSecurityGroup",
"resourceGroupName": "networkSecurityGroupResourceGroup"
},
"ipConfigurations": [{"name": "MyIPConfiguration",
"isPrimary": true,
"subnet": {"name": "MyNetworkInterface",
"resourceGroupName": "networkInterfaceResourceGroup",
"addressPrefix": "addressPrefix"
},
"publicIp": {"name": "MyNetworkInterface",
"resourceGroupName": "networkInterfaceResourceGroup",
"ipAddress": "ipAddress",
"skuName": "skuName"
},
"privateIpAddress": "privateIpAddress",
"privateIPAddressVersion": "privateIPAddressVersion",
"privateIpAllocationMethod": "privateIpAllocationMethod",
"applicationSecurityGroups": [{"name": "MyIPConfiguration",
"resourceGroupName": "networkSecurityGroupResourceGroup"
}
]
}
],
"enableAcceleratedNetworking": true,
"enableIpForwarding": true,
"macAddress": null
}
]
},
"storage": {"osDisk": {"name": "myOsDisk",
"resourceGroupName": "myResourceGroup",
"osType": "Windows",
"storageAccountType": "virtualNetworkResourceGroup",
"sizeGB": 1,
"snapshot": "myOsSnapshot",
"lastCompletedSnapshot": "2022-01-01T00:00:00.000+0000"
},
"dataDisks": [{"name": "MyDataDisk",
"resourceGroupName": "myDataDiskResourceGroup",
"storageAccountType": "virtualNetworkResourceGroup",
"sizeGB": 1,
"lun": 1,
"snapshot": "mySnapshot",
"lastCompletedSnapshot": "2022-01-01T00:00:00.000+0000"
}
]
}
}
],
"count": 1,
"kind": "spotinst:azure:statefulNode:resources"
}
}

Get Stateful Node Status

Get the status of a specific stateful node.

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/azure/compute/statefulNode/ssn-12345678/status",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "ssn-12345678",
"name": "Spot Stateful Node",
"region": "westus2",
"resourceGroupName": "spotResourceGroup",
"status": "active",
"vmName": "spot-12345678-vm",
"vmSize": "spot-12345678-vm",
"lifecycle": "od",
"rollbackReason": "Failed to launch virtual machine in Azure.",
"errorReason": "Deallocate action failed. Please contact our support team.",
"privateIp": "172.23.4.20",
"publicIp": "172.23.4.20",
"createdAt": "2022-01-01T00:00:00.000+0000",
"updatedAt": "2022-01-01T00:00:00.000+0000"
}
],
"count": 1,
"kind": "spotinst:azure:statefulNode:status"
}
}

Get All Stateful Node Statuses

Get the statuses of all stateful nodes in a specific account.

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/azure/compute/statefulNode/status",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "ssn-12345678",
"name": "Spot Stateful Node",
"region": "westus2",
"resourceGroupName": "spotResourceGroup",
"status": "active",
"vmName": "spot-12345678-vm",
"vmSize": "spot-12345678-vm",
"lifecycle": "od",
"rollbackReason": "Failed to launch virtual machine in Azure.",
"errorReason": "Deallocate action failed. Please contact our support team.",
"privateIp": "172.23.4.20",
"publicIp": "172.23.4.20",
"createdAt": "2022-01-01T00:00:00.000+0000",
"updatedAt": "2022-01-01T00:00:00.000+0000"
}
],
"count": 1,
"kind": "spotinst:azure:statefulNode:status"
}
}

Update Stateful Node State

Update the stateful node state.

Authorizations:

path Parameters

nodeId

required

string

Example: ssn-12345678

The ID of the stateful node.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

state

string (Stateful Node State Change)

Enum: "pause" "resume" "recycle"

Responses

Request samples

Payload

Content type

application/json

{"state": "pause"
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/azure/compute/statefulNode/ssn-12345678/state",
"method": "PUT",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [ ],
"count": 1,
"kind": "string"
}
}

Get Stateful Node from an Azure VM

Get the configuration of a stateful node that was built from an Azure VM. This configuration is used for the Import VM to a Stateful Node API.

Authorizations:

path Parameters

resourceGroupName	string Example: importResourceGroup Name of the Resource Group of the imported VM.
virtualMachineName	string Example: spot-12345678-vm Name of the imported VM.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/azure/compute/statefulNode/ssn-12345678",
"method": "POST",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "ssn-12345678",
"name": "Spot Stateful Node",
"region": "westus2",
"resourceGroupName": "spotResourceGroup",
"description": "This is my example stateful node",
"strategy": {"preferredLifecycle": "od",
"signals": [{"type": "vmReady",
"timeout": 180
}
],
"fallbackToOd": true,
"drainingTimeout": 30,
"revertToSpot": {"performAt": "timeWindow"
},
"optimizationWindows": ["Mon:03:00-Wed:02:30"
]
},
"compute": {"os": "Linux",
"vmSizes": {"odSizes": ["standard_a1_v1"
],
"spotSizes": ["standard_a2_v2"
],
"preferredSpotSizes": ["standard_a2_v2"
]
},
"zones": ["1"
],
"preferredZone": "1",
"launchSpecification": {"image": {"marketplace": {"publisher": "OpenLogic",
"offer": "CentOS",
"sku": "7.3",
"version": "7.3-1611"
},
"custom": {"resourceGroupName": "spotinst-azure",
"name": "custom-image-name"
},
"gallery": {"resourceGroupName": "spotinst-azure",
"galleryName": "gallery-name",
"imageName": "gallery-image-name",
"versionName": "0.0.1"
}
},
"vmNamePrefix": "prefix",
"customData": "",
"network": {"resourceGroupName": "subnetResourceGroup",
"virtualNetworkName": "vname",
"networkInterfaces": [{"isPrimary": true,
"subnetName": "testSubnet",
"assignPublicIp": true,
"publicIpSku": "Standard",
"networkSecurityGroup": {"name": "test",
"resourceGroupName": "test"
},
"enableIPForwarding": true,
"privateIpAddresses": [["172.23.4.20"
]
],
"additionalIpConfigurations": [{"name": "test",
"privateIpAddressVersion": "IPv4"
}
],
"publicIps": [{"resourceGroupName": "resourceGroup",
"name": "name"
}
],
"applicationSecurityGroups": [{"resourceGroupName": "AsgResourceGroup",
"name": "AsgName"
}
]
}
]
},
"login": {"userName": "spotinst",
"sshPublicKey": "ssh-rsa"
},
"loadBalancersConfig": {"loadBalancers": [{"type": "loadBalancer",
"resourceGroupName": "testResourceGroup",
"name": "testLoadBalancer",
"loadBalancerSku": "Standard",
"backendPoolNames": ["testBackendPool1",
"testBackendPool2"
]
}
]
},
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"extensions": [{"name": "extensionName",
"type": "customScript",
"publisher": "Microsoft.Azure.Extensions",
"apiVersion": "2.0",
"minorVersionAutoUpgrade": true,
"publicSettings": { },
"protectedSettings": { }
}
],
"dataDisks": [{"sizeGB": 1,
"lun": 1,
"type": "Standard_LRS"
}
],
"osDisk": {"type": "Standard_LRS",
"sizeGB": 30
},
"secrets": [{"sourceVault": {"resourceGroupName": "string",
"name": "string"
},
"vaultCertificates": [{"certificateUrl": "string",
"certificateStore": "string"
}
]
}
],
"bootDiagnostics": {"isEnabled": true,
"type": "managed",
"storageUri": "https://example.blob.core.windows.net/"
}
}
},
"persistence": {"shouldPersistOsDisk": true,
"osDiskPersistenceMode": "onLaunch",
"shouldPersistDataDisks": true,
"dataDisksPersistenceMode": "reattach",
"shouldPersistNetwork": true
},
"scheduling": {"tasks": [{"isEnabled": true,
"type": "recycle",
"cronExpression": "35 12 * * *"
}
]
},
"health": {"healthCheckTypes": ["vmState"
],
"gracePeriod": 120,
"autoHealing": true,
"unhealthyDuration": 360
},
"createdAt": "2022-01-01T00:00:00.000+0000",
"updatedAt": "2022-01-01T00:00:00.000+0000"
}
],
"count": 1,
"kind": "spotinst:azure:statefulNode"
}
}

Import VM to a Stateful Node

Import an Azure VM and create a stateful node by providing a node configuration.

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

object (Azure Import Stateful Node)

drainingTimeout	integer Time in seconds before shutdown incase of load balancing.
required	object (Azure Stateful Node)
originalVmName required	string Azure Import Stateful Node Name
resourceGroupName required	string Name of the Resource Group for Stateful Node.
resourcesRetentionTime	integer Time in hours to delete the original resources after the import has finished

Responses

Request samples

Payload

Content type

application/json

{"statefulNodeImport": {"originalVmName": "Spot Import Stateful Node",
"resourceGroupName": "spotResourceGroup",
"drainingTimeout": 1,
"resourcesRetentionTime": 1,
"node": {"name": "Spot Stateful Node",
"region": "westus2",
"resourceGroupName": "spotResourceGroup",
"description": "This is my example stateful node",
"strategy": {"preferredLifecycle": "od",
"signals": [{"type": "vmReady",
"timeout": 180
}
],
"fallbackToOd": true,
"drainingTimeout": 30,
"revertToSpot": {"performAt": "timeWindow"
},
"optimizationWindows": ["Mon:03:00-Wed:02:30"
]
},
"compute": {"os": "Linux",
"vmSizes": {"odSizes": ["standard_a1_v1"
],
"spotSizes": ["standard_a2_v2"
],
"preferredSpotSizes": ["standard_a2_v2"
]
},
"zones": ["1"
],
"preferredZone": "1",
"launchSpecification": {"image": {"marketplace": {"publisher": "OpenLogic",
"offer": "CentOS",
"sku": "7.3",
"version": "7.3-1611"
},
"custom": {"resourceGroupName": "spotinst-azure",
"name": "custom-image-name"
},
"gallery": {"resourceGroupName": "spotinst-azure",
"galleryName": "gallery-name",
"imageName": "gallery-image-name",
"versionName": "0.0.1"
}
},
"vmNamePrefix": "prefix",
"customData": "",
"shutdownScript": "IyEvdXNyL2Jpbi9lbnYgYmFzaAoiR29vZGJ5ZSBvbGQgaW5zdGFuY2Ui",
"network": {"resourceGroupName": "subnetResourceGroup",
"virtualNetworkName": "vname",
"networkInterfaces": [{"isPrimary": true,
"subnetName": "testSubnet",
"assignPublicIp": true,
"publicIpSku": "Standard",
"networkSecurityGroup": {"name": "test",
"resourceGroupName": "test"
},
"enableIPForwarding": true,
"privateIpAddresses": [["172.23.4.20"
]
],
"additionalIpConfigurations": [{"name": "test",
"privateIpAddressVersion": "IPv4"
}
],
"publicIps": [{"resourceGroupName": "resourceGroup",
"name": "name"
}
],
"applicationSecurityGroups": [{"resourceGroupName": "AsgResourceGroup",
"name": "AsgName"
}
]
}
]
},
"login": {"userName": "spotinst",
"sshPublicKey": "ssh-rsa",
"password": "string"
},
"loadBalancersConfig": {"loadBalancers": [{"type": "loadBalancer",
"resourceGroupName": "testResourceGroup",
"name": "testLoadBalancer",
"loadBalancerSku": "Standard",
"backendPoolNames": ["testBackendPool1",
"testBackendPool2"
]
}
]
},
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"managedServiceIdentities": [{"name": "mySI2",
"resourceGroupName": "myResourceGroup"
}
],
"extensions": [{"name": "extensionName",
"type": "customScript",
"publisher": "Microsoft.Azure.Extensions",
"apiVersion": "2.0",
"minorVersionAutoUpgrade": true,
"publicSettings": { },
"protectedSettings": { }
}
],
"dataDisks": [{"sizeGB": 1,
"lun": 1,
"type": "Standard_LRS"
}
],
"osDisk": {"type": "Standard_LRS",
"sizeGB": 30
},
"secrets": [{"sourceVault": {"resourceGroupName": "string",
"name": "string"
},
"vaultCertificates": [{"certificateUrl": "string",
"certificateStore": "string"
}
]
}
],
"bootDiagnostics": {"isEnabled": true,
"type": "managed",
"storageUri": "https://example.blob.core.windows.net/"
}
}
},
"persistence": {"shouldPersistOsDisk": true,
"osDiskPersistenceMode": "onLaunch",
"shouldPersistDataDisks": true,
"dataDisksPersistenceMode": "reattach",
"shouldPersistNetwork": true
},
"scheduling": {"tasks": [{"isEnabled": true,
"type": "recycle",
"cronExpression": "35 12 * * *"
}
]
},
"health": {"healthCheckTypes": ["vmState"
],
"gracePeriod": 120,
"autoHealing": true,
"unhealthyDuration": 360
}
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/azure/compute/statefulNode/import",
"method": "POST",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"statefulImportId": "sin-12345678",
"originalVmName": "Spot Import Stateful Node",
"resourceGroupName": "spotResourceGroup",
"drainingTimeout": 1,
"resourcesRetentionTime": 1,
"node": {"id": "ssn-12345678",
"name": "Spot Stateful Node",
"region": "westus2",
"resourceGroupName": "spotResourceGroup",
"description": "This is my example stateful node",
"strategy": {"preferredLifecycle": "od",
"signals": [{"type": "vmReady",
"timeout": 180
}
],
"fallbackToOd": true,
"drainingTimeout": 30,
"revertToSpot": {"performAt": "timeWindow"
},
"optimizationWindows": ["Mon:03:00-Wed:02:30"
]
},
"compute": {"os": "Linux",
"vmSizes": {"odSizes": ["standard_a1_v1"
],
"spotSizes": ["standard_a2_v2"
],
"preferredSpotSizes": ["standard_a2_v2"
]
},
"zones": ["1"
],
"preferredZone": "1",
"launchSpecification": {"image": {"marketplace": {"publisher": "OpenLogic",
"offer": "CentOS",
"sku": "7.3",
"version": "7.3-1611"
},
"custom": {"resourceGroupName": "spotinst-azure",
"name": "custom-image-name"
},
"gallery": {"resourceGroupName": "spotinst-azure",
"galleryName": "gallery-name",
"imageName": "gallery-image-name",
"versionName": "0.0.1"
}
},
"vmNamePrefix": "prefix",
"customData": "",
"network": {"resourceGroupName": "subnetResourceGroup",
"virtualNetworkName": "vname",
"networkInterfaces": [{"isPrimary": true,
"subnetName": "testSubnet",
"assignPublicIp": true,
"publicIpSku": "Standard",
"networkSecurityGroup": {"name": "test",
"resourceGroupName": "test"
},
"enableIPForwarding": true,
"privateIpAddresses": [["172.23.4.20"
]
],
"additionalIpConfigurations": [{"name": "test",
"privateIpAddressVersion": "IPv4"
}
],
"publicIps": [{"resourceGroupName": "resourceGroup",
"name": "name"
}
],
"applicationSecurityGroups": [{"resourceGroupName": "AsgResourceGroup",
"name": "AsgName"
}
]
}
]
},
"login": {"userName": "spotinst",
"sshPublicKey": "ssh-rsa"
},
"loadBalancersConfig": {"loadBalancers": [{"type": "loadBalancer",
"resourceGroupName": "testResourceGroup",
"name": "testLoadBalancer",
"loadBalancerSku": "Standard",
"backendPoolNames": ["testBackendPool1",
"testBackendPool2"
]
}
]
},
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
],
"extensions": [{"name": "extensionName",
"type": "customScript",
"publisher": "Microsoft.Azure.Extensions",
"apiVersion": "2.0",
"minorVersionAutoUpgrade": true,
"publicSettings": { },
"protectedSettings": { }
}
],
"dataDisks": [{"sizeGB": 1,
"lun": 1,
"type": "Standard_LRS"
}
],
"osDisk": {"type": "Standard_LRS",
"sizeGB": 30
},
"secrets": [{"sourceVault": {"resourceGroupName": "string",
"name": "string"
},
"vaultCertificates": [{"certificateUrl": "string",
"certificateStore": "string"
}
]
}
],
"bootDiagnostics": {"isEnabled": true,
"type": "managed",
"storageUri": "https://example.blob.core.windows.net/"
}
}
},
"persistence": {"shouldPersistOsDisk": true,
"osDiskPersistenceMode": "onLaunch",
"shouldPersistDataDisks": true,
"dataDisksPersistenceMode": "reattach",
"shouldPersistNetwork": true
},
"scheduling": {"tasks": [{"isEnabled": true,
"type": "recycle",
"cronExpression": "35 12 * * *"
}
]
},
"health": {"healthCheckTypes": ["vmState"
],
"gracePeriod": 120,
"autoHealing": true,
"unhealthyDuration": 360
},
"createdAt": "2022-01-01T00:00:00.000+0000",
"updatedAt": "2022-01-01T00:00:00.000+0000"
}
}
],
"count": 1,
"kind": "spotinst:azure:stateful:import:node"
}
}

Get Stateful Node Import Status

Get the import process status of a stateful node.

Authorizations:

path Parameters

importId

string

Example: sin-12345678

Import Id.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/azure/compute/statefulNode/import/ssn-12345678/status",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"statefulImportId": "sin-12345678",
"statefulNodeId": "ssn-12345678",
"vmName": "spot-12345678-spot",
"state": 1
}
],
"count": 1,
"kind": "spotinst:stateful:import:node"
}
}

Attach Data Disk to Stateful Node

Create a new data disk and attche it to the stateful node.

Authorizations:

path Parameters

nodeId

required

string

Example: ssn-12345678

The ID of the stateful node.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

dataDiskName required	string The name of the created data disk.
dataDiskResourceGroupName required	string The resource group name in which the data disk will be created.
lun	integer Default: "ordinal" The LUN of the data disk. If not defined, the LUN will be set in order.
sizeGB required	integer [ 1 .. 1023 ] The size of the data disk in GB, Required if dataDisks is specified.
storageAccountType required	string Enum: "Standard_LRS" "Premium_LRS" "StandardSSD_LRS" "UltraSSD_LRS" The type of the data disk.
zone	string Enum: 1 2 3 The Availability Zone in which the data disk will be created. If not defined, the data disk will be created regionally.

Responses

Request samples

Payload

Content type

application/json

{"dataDiskName": "MyDisk",
"dataDiskResourceGroupName": "dataDiskResourceGroup",
"sizeGB": 1,
"lun": 1,
"storageAccountType": "Standard_LRS",
"zone": 1
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/azure/compute/statefulNode/ssn-12345678/dataDisk/attach",
"method": "PUT",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"name": "MyDisk",
"resourceGroupName": "dataDiskResourceGroup",
"region": "westus2",
"zone": 1,
"size": 1,
"lun": 1,
"accountType": "Standard_LRS",
"managedBy": "spot-12345678-vm",
"tags": [{"tagKey": "env",
"tagValue": "staging"
}
]
}
],
"count": 1,
"kind": "spotinst:azure:disk"
}
}

Detach Data Disk From Stateful Node

Detach a data disk from a stateful node.

Authorizations:

path Parameters

nodeId

required

string

Example: ssn-12345678

The ID of the stateful node.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

dataDiskName required	string The name of the created data disk.
dataDiskResourceGroupName required	string The resource group name in which the data disk exists.
shouldDeallocate required	boolean Indicates whether to delete the data disk in addition to detach.
ttlInHours	integer Default: 0 Hours to keep the disk alive before deletion.

Responses

Request samples

Payload

Content type

application/json

{"dataDiskName": "MyDisk",
"dataDiskResourceGroupName": "dataDiskResourceGroup",
"shouldDeallocate": true,
"ttlInHours": 1
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/azure/compute/statefulNode/ssn-12345678/dataDisk/detach",
"method": "PUT",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [ ],
"count": 1,
"kind": "string"
}
}

Get Stateful Node Logs

Get the logs of a stateful node according to severity and time period filter parameters.

Authorizations:

path Parameters

nodeId

required

string

Example: ssn-12345678

The ID of the stateful node.

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
required	unix (string) or dateTime (string) Example: fromDate=2020-09-01 or fromDate=1598918400000 Get items on or after this date (ISO 8601 or Unix timestamp)
limit	integer [ 0 .. 1000 ] Example: limit=100 Maximum number of lines to extract in a response.
resourceId	string Example: resourceId=ssn-12345678 Filter log extracted entires related to a specific resource id
severity	string Enum: "DEBUG" "WARN" "INFO" "ALL" "ERROR" Example: severity=WARN Severity of log entries to extract.
required	unix (string) or dateTime (string) Example: toDate=2020-09-01 or toDate=1598918400000 Get items on or before this date (ISO 8601 or Unix timestamp)

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/azure/compute/statefulNode/ssn-12345678/log",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"message": "Successfully created stateful node",
"severity": "INFO",
"createdAt": "2022-01-01T00:00:00.000Z"
}
],
"count": 1,
"kind": "spotinst:azure:statefulNode:logs"
}
}

Get All Stateful Node Costs

Get the total costs of a single stateful node/all stateful nodes and for a specific time period.

Authorizations:

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
required	unix (string) or dateTime (string) Example: fromDate=2020-09-01 or fromDate=1598918400000 Get items on or after this date (ISO 8601 or Unix timestamp)
ownerId	string Example: ownerId=ssn-12345678 Aggregates costs and usage by stateful node.
required	unix (string) or dateTime (string) Example: toDate=2020-09-01 or toDate=1598918400000 Get items on or before this date (ISO 8601 or Unix timestamp)

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/azure/compute/statefulNode/cost",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"usage": {"spot": {"hours": 2781.758
},
"od": {"hours": 0
}
},
"cost": {"odCost": 0,
"spotPotentialCost": 380.9154,
"spotActualCost": 118.7367
}
}
],
"count": 1,
"kind": "spotinst:azure:statefulNode:cost"
}
}

Get All Stateful Node Aggregated Daily Costs

Get the total costs per day of a single stateful node/all stateful nodes and for a specific time period.

Authorizations:

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
required	unix (string) or dateTime (string) Example: fromDate=2020-09-01 or fromDate=1598918400000 Get items on or after this date (ISO 8601 or Unix timestamp)
ownerId	string Example: ownerId=ssn-12345678 Aggregates costs and usage daily by stateful node.
required	unix (string) or dateTime (string) Example: toDate=2020-09-01 or toDate=1598918400000 Get items on or before this date (ISO 8601 or Unix timestamp)

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/azure/compute/statefulNode/cost/daily",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"usage": {"spot": {"hours": 2781.758
},
"od": {"hours": 0
}
},
"cost": {"odCost": 0,
"spotPotentialCost": 380.9154,
"spotActualCost": 118.7367,
"day": "2022-01-01T00:00:00.000+0000"
}
}
],
"count": 1,
"kind": "spotinst:azure:statefulNode:cost"
}
}

Get Stateful Node Size Usage

Get the daily costs per VM size of a single stateful node/all stateful nodes and for a specific time period.

Authorizations:

Managed Instance for AWS Concepts and Tutorials

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
required	unix (string) or dateTime (string) Example: fromDate=2020-09-01 or fromDate=1598918400000 Get items on or after this date (ISO 8601 or Unix timestamp)
ownerId	string Example: ownerId=ssn-12345678 Aggregates VM size usage daily by stateful node.
required	unix (string) or dateTime (string) Example: toDate=2020-09-01 or toDate=1598918400000 Get items on or before this date (ISO 8601 or Unix timestamp)

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/azure/compute/statefulNode/sizeUsage/daily",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"day": "2022-01-01T00:00:00.000+0000",
"cpus": 60,
"lifeCycle": "spot",
"vmSize": "standard_a1_v2"
}
],
"count": 1,
"kind": "spotinst:azure:stateful:dailySizeUsage"
}
}

Managed Instance AWS

Managed Instance is a Spot solution for launching and managing a single compute instance. On the AWS cloud, for a standard single instance workload, an On-Demand EC2 instance is launched. The instance is expected to be highly available, easily manageable, and integrate well with additional services and monitoring tools. For more information please review the concepts section.

Create Managed Instance

Create a new Managed Instance resource.

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

object

	object (MI Compute)
description	string Describe your Managed Instance resource
	object
	object (MI integrations)
name	string Managed Instance name
	object Persistence settings. Should omit at least one of the persist options below.
region	string The AWS region your resource will be created in.
	object (MI Scheduling)
	object (MI Strategy)

Responses

Request samples

Payload

Content type

application/json

{"managedInstance": {"name": "mi-test",
"description": "This is my Managed Instance",
"region": "us-east-1",
"strategy": {"lifeCycle": "spot",
"orientation": "availabilityOriented",
"drainingTimeout": 0,
"fallbackToOd": true,
"utilizeReservedInstances": true,
"utilizeCommitments": false,
"optimizationWindows": ["Mon:03:00-Wed:02:30"
],
"revertToSpot": {"performAt": "timeWindow"
}
},
"compute": {"subnetIds": ["subnet-79da021e"
],
"vpcId": "vpc-111",
"elasticIp": "ip",
"privateIp": "ip",
"product": "Linux/UNIX",
"launchSpecification": {"instanceTypes": {"preferredType": "t2.micro",
"types": ["t2.micro"
]
},
"ebsOptimized": false,
"monitoring": false,
"tenancy": "default",
"iamRole": {"name": "name",
"arn": "arn"
},
"securityGroupIds": ["sg-0dfc2c8760df6fec7"
],
"imageId": "ami-01e24be29428c15b2",
"keyPair": "labs-oregon",
"tags": [{"tagKey": "Creator",
"tagValue": "test1@spot.io"
}
],
"resourceTagSpecification": {"volumes": {"shouldTag": false
},
"snapshots": {"shouldTag": true
},
"enis": {"shouldTag": false
},
"amis": {"shouldTag": true
}
},
"userData": "dXNlcmJhc2g2NGVuY29kZWQ=",
"shutdownScript": "dXNlcmJhc2g2NGVuY29kZWQ=",
"creditSpecification": {"cpuCredits": "unlimited"
},
"networkInterfaces": [{"deviceIndex": 0,
"associatePublicIpAddress": true,
"associateIpv6Address": true
}
],
"blockDeviceMappings": [{"deviceName": "/dev/xvdcz",
"ebs": {"iops": 0,
"throughput": 125,
"deleteOnTermination": true,
"volumeSize": 12,
"volumeType": "gp2"
}
}
]
}
},
"integrations": {"loadBalancersConfig": {"loadBalancers": [{"name": "name",
"arn": "arn",
"type": "MULTAI_TARGET_SET",
"balancerId": "lb-1ee2e3q",
"targetSetId": "ts-3eq",
"azAwareness": true,
"autoWeight": true
}
]
},
"route53": {"domains": [{"hostedZoneId": "Z00275642KS5ZZJFIQBCA",
"recordSetType": "a",
"spotinstAccountId": "act-1234",
"recordSets": [{"usePublicIp": true,
"name": "testa.spot.io"
}
]
}
]
}
},
"scheduling": {"tasks": [{"taskType": "scale",
"startTime": "2018-05-23T10:55:09Z",
"cronExpression": "0 1 * * *",
"isEnabled": true,
"frequency": "hourly"
}
]
},
"persistence": {"blockDevicesMode": "reattach",
"persistRootDevice": true,
"persistBlockDevices": true,
"persistPrivateIp": true
},
"healthCheck": {"type": "EC2",
"autoHealing": true,
"gracePeriod": 120,
"unhealthyDuration": 120
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"managedInstance": {"name": "mi-test",
"description": "This is my Managed Instance",
"region": "us-east-1",
"strategy": {"lifeCycle": "spot",
"orientation": "availabilityOriented",
"drainingTimeout": 0,
"fallbackToOd": true,
"utilizeReservedInstances": true,
"utilizeCommitments": false,
"optimizationWindows": ["Mon:03:00-Wed:02:30"
],
"revertToSpot": {"performAt": "timeWindow"
}
},
"compute": {"subnetIds": ["subnet-79da021e"
],
"vpcId": "vpc-111",
"elasticIp": "ip",
"privateIp": "ip",
"product": "Linux/UNIX",
"launchSpecification": {"instanceTypes": {"preferredType": "t2.micro",
"types": ["t2.micro"
]
},
"ebsOptimized": false,
"monitoring": false,
"tenancy": "default",
"iamRole": {"name": "name",
"arn": "arn"
},
"securityGroupIds": ["sg-0dfc2c8760df6fec7"
],
"imageId": "ami-01e24be29428c15b2",
"keyPair": "labs-oregon",
"tags": [{"tagKey": "Creator",
"tagValue": "test1@spot.io"
}
],
"resourceTagSpecification": {"volumes": {"shouldTag": false
},
"snapshots": {"shouldTag": true
},
"enis": {"shouldTag": false
},
"amis": {"shouldTag": true
}
},
"userData": "dXNlcmJhc2g2NGVuY29kZWQ=",
"shutdownScript": "dXNlcmJhc2g2NGVuY29kZWQ=",
"creditSpecification": {"cpuCredits": "unlimited"
},
"networkInterfaces": [{"deviceIndex": 0,
"associatePublicIpAddress": true,
"associateIpv6Address": true
}
],
"blockDeviceMappings": [{"deviceName": "/dev/xvdcz",
"ebs": {"iops": 0,
"throughput": 125,
"deleteOnTermination": true,
"volumeSize": 12,
"volumeType": "gp2"
}
}
]
}
},
"integrations": {"loadBalancersConfig": {"loadBalancers": [{"name": "name",
"arn": "arn",
"type": "MULTAI_TARGET_SET",
"balancerId": "lb-1ee2e3q",
"targetSetId": "ts-3eq",
"azAwareness": true,
"autoWeight": true
}
]
},
"route53": {"domains": [{"hostedZoneId": "Z00275642KS5ZZJFIQBCA",
"recordSetType": "a",
"spotinstAccountId": "act-1234",
"recordSets": [{"usePublicIp": true,
"name": "testa.spot.io"
}
]
}
]
}
},
"scheduling": {"tasks": [{"taskType": "scale",
"startTime": "2018-05-23T10:55:09Z",
"cronExpression": "0 1 * * *",
"isEnabled": true,
"frequency": "hourly"
}
]
},
"persistence": {"blockDevicesMode": "reattach",
"persistRootDevice": true,
"persistBlockDevices": true,
"persistPrivateIp": true
},
"healthCheck": {"type": "EC2",
"autoHealing": true,
"gracePeriod": 120,
"unhealthyDuration": 120
}
}
}
],
"count": 1,
"kind": "spotinst:aws:ec2:managedInstance"
}
}

List Managed Instances

List all Managed Instance resources in the account.

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"createdAt": "2020-04-10T21:41:31.000Z",
"updatedAt": "2020-05-12T22:37:18.000Z",
"id": "smi-34ae3a42",
"config": {"name": "mi-test",
"region": "us-east-1",
"strategy": {"lifeCycle": "spot",
"orientation": "availabilityOriented",
"drainingTimeout": 0,
"fallbackToOd": true,
"utilizeReservedInstances": true,
"utilizeCommitments": false,
"optimizationWindows": ["Mon:03:00-Wed:02:30"
],
"revertToSpot": {"performAt": "timeWindow"
}
},
"persistence": {"blockDevicesMode": "reattach",
"persistRootDevice": true,
"persistBlockDevices": true,
"persistPrivateIp": true
},
"healthCheck": {"type": "EC2",
"autoHealing": true,
"gracePeriod": 120,
"unhealthyDuration": 120
},
"compute": {"subnetIds": ["subnet-79da021e"
],
"vpcId": "vpc-111",
"elasticIp": "ip",
"privateIp": "ip",
"product": "Linux/UNIX",
"launchSpecification": {"instanceTypes": {"preferredType": "t2.micro",
"types": ["t2.micro"
]
},
"ebsOptimized": false,
"monitoring": false,
"tenancy": "default",
"iamRole": {"name": "name",
"arn": "arn"
},
"securityGroupIds": ["sg-0dfc2c8760df6fec7"
],
"imageId": "ami-01e24be29428c15b2",
"keyPair": "labs-oregon",
"tags": [{"tagKey": "Creator",
"tagValue": "test1@spot.io"
}
],
"resourceTagSpecification": {"volumes": {"shouldTag": false
},
"snapshots": {"shouldTag": true
},
"enis": {"shouldTag": false
},
"amis": {"shouldTag": true
}
},
"userData": "dXNlcmJhc2g2NGVuY29kZWQ=",
"shutdownScript": "dXNlcmJhc2g2NGVuY29kZWQ=",
"creditSpecification": {"cpuCredits": "unlimited"
},
"networkInterfaces": [{"deviceIndex": 0,
"associatePublicIpAddress": true,
"associateIpv6Address": true
}
],
"blockDeviceMappings": [{"deviceName": "/dev/xvdcz",
"ebs": {"iops": 0,
"throughput": 125,
"deleteOnTermination": true,
"volumeSize": 12,
"volumeType": "gp2"
}
}
]
}
},
"integrations": {"loadBalancersConfig": {"loadBalancers": [{"name": "name",
"arn": "arn",
"type": "MULTAI_TARGET_SET",
"balancerId": "lb-1ee2e3q",
"targetSetId": "ts-3eq",
"azAwareness": true,
"autoWeight": true
}
]
},
"route53": {"domains": [{"hostedZoneId": "Z00275642KS5ZZJFIQBCA",
"recordSetType": "a",
"spotinstAccountId": "act-1234",
"recordSets": [{"usePublicIp": true,
"name": "testa.spot.io"
}
]
}
]
}
},
"scheduling": {"tasks": [{"taskType": "scale",
"startTime": "2018-05-23T10:55:09Z",
"cronExpression": "0 1 * * *",
"isEnabled": true,
"frequency": "hourly"
}
]
}
}
}
],
"count": 1,
"kind": "spotinst:aws:ec2:managedInstance"
}
}

Update Managed Instance

Update one or more attributes in your Managed Instance.
This API supports partial updates, so only specific fields can be updated separately.
In order to remove a setting from the instance config, set the object value to null.
For a Full List of the Elastigroup JSON object reference please see Managed Instance Create.

Authorizations:

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
MI_ID required	string Example: MI_ID=smi-111 Managed Instance ID you want to get

Request Body schema: application/json

object

	object (MI Compute)
description	string Describe your Managed Instance resource
	object
	object (MI integrations)
name	string Managed Instance name
	object Persistence settings. Should omit at least one of the persist options below.
region	string The AWS region your resource will be created in.
	object (MI Scheduling)
	object (MI Strategy)

Responses

Request samples

Payload

Content type

application/json

{"managedInstance": {"name": "mi-test",
"description": "This is my Managed Instance",
"region": "us-east-1",
"strategy": {"lifeCycle": "spot",
"orientation": "availabilityOriented",
"drainingTimeout": 0,
"fallbackToOd": true,
"utilizeReservedInstances": true,
"utilizeCommitments": false,
"optimizationWindows": ["Mon:03:00-Wed:02:30"
],
"revertToSpot": {"performAt": "timeWindow"
}
},
"compute": {"subnetIds": ["subnet-79da021e"
],
"vpcId": "vpc-111",
"elasticIp": "ip",
"privateIp": "ip",
"product": "Linux/UNIX",
"launchSpecification": {"instanceTypes": {"preferredType": "t2.micro",
"types": ["t2.micro"
]
},
"ebsOptimized": false,
"monitoring": false,
"tenancy": "default",
"iamRole": {"name": "name",
"arn": "arn"
},
"securityGroupIds": ["sg-0dfc2c8760df6fec7"
],
"imageId": "ami-01e24be29428c15b2",
"keyPair": "labs-oregon",
"tags": [{"tagKey": "Creator",
"tagValue": "test1@spot.io"
}
],
"resourceTagSpecification": {"volumes": {"shouldTag": false
},
"snapshots": {"shouldTag": true
},
"enis": {"shouldTag": false
},
"amis": {"shouldTag": true
}
},
"userData": "dXNlcmJhc2g2NGVuY29kZWQ=",
"shutdownScript": "dXNlcmJhc2g2NGVuY29kZWQ=",
"creditSpecification": {"cpuCredits": "unlimited"
},
"networkInterfaces": [{"deviceIndex": 0,
"associatePublicIpAddress": true,
"associateIpv6Address": true
}
],
"blockDeviceMappings": [{"deviceName": "/dev/xvdcz",
"ebs": {"iops": 0,
"throughput": 125,
"deleteOnTermination": true,
"volumeSize": 12,
"volumeType": "gp2"
}
}
]
}
},
"integrations": {"loadBalancersConfig": {"loadBalancers": [{"name": "name",
"arn": "arn",
"type": "MULTAI_TARGET_SET",
"balancerId": "lb-1ee2e3q",
"targetSetId": "ts-3eq",
"azAwareness": true,
"autoWeight": true
}
]
},
"route53": {"domains": [{"hostedZoneId": "Z00275642KS5ZZJFIQBCA",
"recordSetType": "a",
"spotinstAccountId": "act-1234",
"recordSets": [{"usePublicIp": true,
"name": "testa.spot.io"
}
]
}
]
}
},
"scheduling": {"tasks": [{"taskType": "scale",
"startTime": "2018-05-23T10:55:09Z",
"cronExpression": "0 1 * * *",
"isEnabled": true,
"frequency": "hourly"
}
]
},
"persistence": {"blockDevicesMode": "reattach",
"persistRootDevice": true,
"persistBlockDevices": true,
"persistPrivateIp": true
},
"healthCheck": {"type": "EC2",
"autoHealing": true,
"gracePeriod": 120,
"unhealthyDuration": 120
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"managedInstance": {"name": "mi-test",
"description": "This is my Managed Instance",
"region": "us-east-1",
"strategy": {"lifeCycle": "spot",
"orientation": "availabilityOriented",
"drainingTimeout": 0,
"fallbackToOd": true,
"utilizeReservedInstances": true,
"utilizeCommitments": false,
"optimizationWindows": ["Mon:03:00-Wed:02:30"
],
"revertToSpot": {"performAt": "timeWindow"
}
},
"compute": {"subnetIds": ["subnet-79da021e"
],
"vpcId": "vpc-111",
"elasticIp": "ip",
"privateIp": "ip",
"product": "Linux/UNIX",
"launchSpecification": {"instanceTypes": {"preferredType": "t2.micro",
"types": ["t2.micro"
]
},
"ebsOptimized": false,
"monitoring": false,
"tenancy": "default",
"iamRole": {"name": "name",
"arn": "arn"
},
"securityGroupIds": ["sg-0dfc2c8760df6fec7"
],
"imageId": "ami-01e24be29428c15b2",
"keyPair": "labs-oregon",
"tags": [{"tagKey": "Creator",
"tagValue": "test1@spot.io"
}
],
"resourceTagSpecification": {"volumes": {"shouldTag": false
},
"snapshots": {"shouldTag": true
},
"enis": {"shouldTag": false
},
"amis": {"shouldTag": true
}
},
"userData": "dXNlcmJhc2g2NGVuY29kZWQ=",
"shutdownScript": "dXNlcmJhc2g2NGVuY29kZWQ=",
"creditSpecification": {"cpuCredits": "unlimited"
},
"networkInterfaces": [{"deviceIndex": 0,
"associatePublicIpAddress": true,
"associateIpv6Address": true
}
],
"blockDeviceMappings": [{"deviceName": "/dev/xvdcz",
"ebs": {"iops": 0,
"throughput": 125,
"deleteOnTermination": true,
"volumeSize": 12,
"volumeType": "gp2"
}
}
]
}
},
"integrations": {"loadBalancersConfig": {"loadBalancers": [{"name": "name",
"arn": "arn",
"type": "MULTAI_TARGET_SET",
"balancerId": "lb-1ee2e3q",
"targetSetId": "ts-3eq",
"azAwareness": true,
"autoWeight": true
}
]
},
"route53": {"domains": [{"hostedZoneId": "Z00275642KS5ZZJFIQBCA",
"recordSetType": "a",
"spotinstAccountId": "act-1234",
"recordSets": [{"usePublicIp": true,
"name": "testa.spot.io"
}
]
}
]
}
},
"scheduling": {"tasks": [{"taskType": "scale",
"startTime": "2018-05-23T10:55:09Z",
"cronExpression": "0 1 * * *",
"isEnabled": true,
"frequency": "hourly"
}
]
},
"persistence": {"blockDevicesMode": "reattach",
"persistRootDevice": true,
"persistBlockDevices": true,
"persistPrivateIp": true
},
"healthCheck": {"type": "EC2",
"autoHealing": true,
"gracePeriod": 120,
"unhealthyDuration": 120
}
}
}
],
"count": 1,
"kind": "spotinst:aws:ec2:managedInstance"
}
}

Get Managed Instance

Get specific Managed Instance config.

Authorizations:

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
MI_ID required	string Example: MI_ID=smi-111 Managed Instance ID you want to get

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"managedInstance": {"name": "mi-test",
"description": "This is my Managed Instance",
"region": "us-east-1",
"strategy": {"lifeCycle": "spot",
"orientation": "availabilityOriented",
"drainingTimeout": 0,
"fallbackToOd": true,
"utilizeReservedInstances": true,
"utilizeCommitments": false,
"optimizationWindows": ["Mon:03:00-Wed:02:30"
],
"revertToSpot": {"performAt": "timeWindow"
}
},
"compute": {"subnetIds": ["subnet-79da021e"
],
"vpcId": "vpc-111",
"elasticIp": "ip",
"privateIp": "ip",
"product": "Linux/UNIX",
"launchSpecification": {"instanceTypes": {"preferredType": "t2.micro",
"types": ["t2.micro"
]
},
"ebsOptimized": false,
"monitoring": false,
"tenancy": "default",
"iamRole": {"name": "name",
"arn": "arn"
},
"securityGroupIds": ["sg-0dfc2c8760df6fec7"
],
"imageId": "ami-01e24be29428c15b2",
"keyPair": "labs-oregon",
"tags": [{"tagKey": "Creator",
"tagValue": "test1@spot.io"
}
],
"resourceTagSpecification": {"volumes": {"shouldTag": false
},
"snapshots": {"shouldTag": true
},
"enis": {"shouldTag": false
},
"amis": {"shouldTag": true
}
},
"userData": "dXNlcmJhc2g2NGVuY29kZWQ=",
"shutdownScript": "dXNlcmJhc2g2NGVuY29kZWQ=",
"creditSpecification": {"cpuCredits": "unlimited"
},
"networkInterfaces": [{"deviceIndex": 0,
"associatePublicIpAddress": true,
"associateIpv6Address": true
}
],
"blockDeviceMappings": [{"deviceName": "/dev/xvdcz",
"ebs": {"iops": 0,
"throughput": 125,
"deleteOnTermination": true,
"volumeSize": 12,
"volumeType": "gp2"
}
}
]
}
},
"integrations": {"loadBalancersConfig": {"loadBalancers": [{"name": "name",
"arn": "arn",
"type": "MULTAI_TARGET_SET",
"balancerId": "lb-1ee2e3q",
"targetSetId": "ts-3eq",
"azAwareness": true,
"autoWeight": true
}
]
},
"route53": {"domains": [{"hostedZoneId": "Z00275642KS5ZZJFIQBCA",
"recordSetType": "a",
"spotinstAccountId": "act-1234",
"recordSets": [{"usePublicIp": true,
"name": "testa.spot.io"
}
]
}
]
}
},
"scheduling": {"tasks": [{"taskType": "scale",
"startTime": "2018-05-23T10:55:09Z",
"cronExpression": "0 1 * * *",
"isEnabled": true,
"frequency": "hourly"
}
]
},
"persistence": {"blockDevicesMode": "reattach",
"persistRootDevice": true,
"persistBlockDevices": true,
"persistPrivateIp": true
},
"healthCheck": {"type": "EC2",
"autoHealing": true,
"gracePeriod": 120,
"unhealthyDuration": 120
}
}
}
],
"count": 1,
"kind": "spotinst:aws:ec2:managedInstance"
}
}

Delete Managed Instance

Get specific Managed Instance config.

Authorizations:

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
MI_ID required	string Example: MI_ID=smi-111 Managed Instance ID you want to get

Request Body schema: application/json

	object
	object

Responses

Request samples

Payload

Content type

application/json

{"deallocationConfig": {"shouldDeleteImages": true,
"shouldDeleteNetworkInterfaces": true,
"shouldDeleteVolumes": true,
"shouldDeleteSnapshots": true,
"shouldTerminateInstance": true
},
"amiBackup": {"shouldDeleteImages": true
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Pause Managed Instance

Pause an existing Managed Instance.

Authorizations:

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
MI_ID required	string Example: MI_ID=smi-111 Managed Instance ID you want to get

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Resume Managed Instance

Resume an existing Managed Instance.

Authorizations:

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
MI_ID required	string Example: MI_ID=smi-111 Managed Instance ID you want to get

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Recycle Managed Instance

Recycle an existing Managed Instance.

Authorizations:

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
MI_ID required	string Example: MI_ID=smi-111 Managed Instance ID you want to get

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Get Managed Instance Costs

Get financial information on a specific managed instance. To use this API, managedInstanceId must be defined.

Authorizations:

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
aggregationPeriod	string Data values following either a date format (YYYY-MM-DDTHH:mm:ss.SSSZ ; 2016-01-10T00:00:00.000Z) or Unix seconds Timestamp (1494751821)
fromDate required	string <date-time> Example: fromDate=2019-05-17 Get items on or after this date (ISO 8601)
MI_ID required	string Example: MI_ID=smi-111 Managed Instance ID you want to get
toDate required	string <date-time> Example: toDate=2019-05-25 Get items on or before this date (ISO 8601)

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"running": {"value": 4,
"unit": "hours"
},
"savings": {"value": 0,
"unit": "percentage"
},
"costs": {"actual": 0.268,
"potential": 0.268
}
}
],
"count": 1,
"kind": "spotinst:aws:ec2:managedInstance:costs"
}
}

Get Managed Instance Status

Describes the current status of a specific Managed Instance – entailing information regarding running instance and its status.

Authorizations:

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
MI_ID required	string Example: MI_ID=smi-111 Managed Instance ID you want to get

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "smi-50739ad2",
"name": "i-0db00q51ec9069ebf",
"status": "ACTIVE",
"instanceId": "i-0vc9530daq19c4aad",
"instanceType": "t2.micro",
"imageId": "ami-03238ecdbdc7d6d6a",
"privateIp": "172.31.10.21",
"publicIp": "34.212.65.224",
"createdAt": "2020-05-05T08:53:12.000Z",
"launchedAt": "2020-05-05T08:53:12.000Z"
}
],
"count": 1,
"kind": "spotinst:aws:ec2:managedInstanceStatus"
}
}

Delete Volume in a Managed Instance

Delete a Volume that is part of a managed instance

Authorizations:

path Parameters

MI_ID required	string Example: smi-123456 Managed Instance ID
volumeId required	string Example: vol-0faa4b2957a3d59c8 Volume ID

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "3b750eff-3940-46b3-a309-aa2b415272fd",
"url": "/aws/ec2/managedInstance/smi-123456/volume/vol-0faa4b2957a3d59c8",
"method": "DELETE",
"timestamp": "2021-11-03T11:02:55.608Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Import Instance from AWS

Import an instance from AWS into Managed Instance, while keeping the instance data and its persistence settings.
This call is starting the migration and returns migration ID.
In order to get migration status use the Get Migration Status call

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

object (Migration)

Migration Configuration

	Array of objects (Availability Zones) [ items ] List of availability zones for the Managed Instance. Should exist only if shouldKeepPrivateIp is false.
managedInstanceName	string Set Managed Instance name
originalInstanceId	string The instance ID on AWS
product	string Set instance's product
region	string Set instance's region
shouldKeepPrivateIp	boolean Set whether the instance should keep its private ip or not
shouldTerminateInstance	boolean Set true or false whether to terminate the instance in AWS. Note: If shouldKeepPrivateIp is true, then shouldTerminateInstance must be true. Otherwise an error will be returned.
spotInstanceTypes	Array of strings List of possible instance types for the Managed Instance

Responses

Request samples

Payload

Content type

application/json

{"migration": {"shouldKeepPrivateIp": false,
"originalInstanceId": "i-123",
"region": "us-east-1",
"shouldTerminateInstance": false,
"managedInstanceName": "us-east-1",
"product": "Linux/UNIX",
"spotInstanceTypes": ["m3.large"
],
"availabilityZones": [{"name": "us-west-2c",
"subnetIds": ["subnet-fdfb00a0"
]
}
]
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"migrationId": "smg-123",
"managedInstanceId": "smi-123",
"data": {"originalInstanceId": "i-123",
"shouldKeepPrivateIp": true
},
"state": "MIGRATE_START"
}
],
"count": 1,
"kind": "potinst:aws:ec2:managedInstance:migration"
}
}

Get Instance Migration Status

Get a previously initiated instance migration status.
To initiate an instance migration from AWS use the Import Instance From AWS call.
On initiation, the migration would be in the following state: `MIGRATE_START`.
Possible end states for the migration are: `MIGRATE_CANCEL`, `MIGRATE_FINISH`, `MIGRATE_ERROR`.

Authorizations:

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
MI_ID required	string Example: MI_ID=smi-111 Managed Instance ID you want to get

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"migrationId": "smg-123",
"managedInstanceId": "smi-123",
"state": "MIGRATE_START",
"instanceId": "i-123"
}
],
"count": 1,
"kind": "potinst:aws:ec2:managedInstance:migration"
}
}

Update Managed Instance States

Update the state of multiple managed instances.

Authorizations:

https://docs.spot.io/api/#tag/Audit-Service

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

required

Array of objects (Managed Instance State) [ items ]

An array of Managed Instance State objects (must contain at least 1 object).

Array

id required	string Identifier of the managed instance.
state required	string Enum: "PAUSE" "RESUME" The new state of the managed instance.

Responses

Request samples

Payload

Content type

application/json

{"managedInstanceStates": {"managedInstanceStates": [{"id": "smi-12345678",
"state": "PAUSE"
},
{"id": "smi-12345679",
"state": "RESUME"
}
]
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/aws/ec2/managedInstance/state?spotinstAccountId=act-123456",
"method": "PUT",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Audit Service

List Audit Log Events

Gets audit events that have response status of 200. This is the default when the responseStatus parameter is not included in the query. When you use responseStatus in the query, you can get all audit events without regard to status.

The API requires one of the following permissions to be defined in Spot:

Permission: Organization Viewer (See User Roles) or
Action: setup:describeAllAuditEvents (See Access Policies)

Authorizations:

https://docs.spot.io/elastigroup/tools-integrations/custom-health-check-service

query Parameters

accountId	any Example: accountId=act-123abc ID of the account associated with your token
fromDate required	string <string> Example: fromDate=1598918400000 Get items on or after this date (Unix timestamp)
responseStatus	any Example: responseStatus=all Determines whether the audit events should be filtered by their response status code or not. Valid values: "success": Gets only events with status 200. "all": Audit events will not be filtered by response status codes, and all the events will be returned. Default: success
toDate required	string <string> Example: toDate=1598918400000 Get items on or before this date (Unix timestamp)

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"user": "test@spot.io",
"namespace": "GENERAL",
"actionType": "Sign in with SSO",
"resourceType": "User",
"resourceId": 21126,
"createdAt": "2020-06-01T12:17:51.000Z",
"context": "{\"body\":{\"email\":\"test@spot.io\",\"isMarketplaceCustomer\":false},\"url\":\"/signIn/sso\",\"query\":{}}",
"source": "UI",
"agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/33.9.1667.012 Safari/537.36",
"responseStatus": 200
}
],
"count": 1,
"kind": "spotinst:audit"
}
}

Health Check Service

Create Health Check

Create an HCS for Spot Elastigroup.

Authorizations:

query Parameters

accountId

any

Example: accountId=act-123abc

ID of the account associated with your token

Request Body schema: application/json

required

object

Group

	object
name	string A logical name for the health check
proxyAddress	string The public hostname / IP where you installed the the Spot HCS
proxyPort	integer The port of the HCS. Default: 80
resourceId	string Spot Resource ID

Responses

Request samples

Payload

Content type

application/json

{"healthCheck": {"resourceId": 21126,
"name": "Service-1-healthCheck",
"proxyAddress": "51.22.125.47",
"proxyPort": 80,
"check": {"protocol": "http",
"port": 80,
"endpoint": "index.html",
"unhealthyThreshold": 2,
"healthyThreshold": 2,
"interval": 30,
"timeout": 60
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": 1,
"resourceId": "sig-12345",
"name": "Service-1-healthCheck",
"proxyAddress": "51.22.125.47",
"proxyPort": 80,
"check": {"protocol": "http",
"port": 80,
"endpoint": "index.html",
"unhealthyThreshold": 2,
"healthyThreshold": 2,
"interval": 30,
"timeout": 60
}
}
],
"count": 1,
"kind": "spotinst:healthCheck"
}
}

List Health Checks

Get a list of all HCS services.

Authorizations:

query Parameters

accountId

any

Example: accountId=act-123abc

ID of the account associated with your token

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": 1,
"resourceId": "sig-12345",
"name": "Service-1-healthCheck",
"proxyAddress": "51.22.125.47",
"proxyPort": 80,
"check": {"protocol": "http",
"port": 80,
"endpoint": "index.html",
"unhealthyThreshold": 2,
"healthyThreshold": 2,
"interval": 30,
"timeout": 60
}
}
],
"count": 1,
"kind": "spotinst:healthCheck"
}
}

Update Health Check

Update existing HCS.

Authorizations:

query Parameters

accountId	any Example: accountId=act-123abc ID of the account associated with your token
HEALTHCHECK_ID required	any Example: HEALTHCHECK_ID=hcs-123 The HCS you want to update

Request Body schema: application/json

required

object

Group

object

healthyThreshold	integer The number of consecutive successful health checks that must occur before declaring an instance healthy
interval	integer The amount of time (in seconds) between each health check. Minimum value is 10
unhealthyThreshold	integer The number of consecutive failed health checks that must occur before declaring an instance unhealthy

Responses

Request samples

Payload

Content type

application/json

{"healthCheck": {"check": {"unhealthyThreshold": 2,
"healthyThreshold": 2,
"interval": 30
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Get Health Check

List the information of a particular HCS

Authorizations:

query Parameters

accountId	any Example: accountId=act-123abc ID of the account associated with your token
HEALTHCHECK_ID required	any Example: HEALTHCHECK_ID=hcs-123 The HCS you want to update

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": 1,
"resourceId": "sig-12345",
"name": "Service-1-healthCheck",
"proxyAddress": "51.22.125.47",
"proxyPort": 80,
"check": {"protocol": "http",
"port": 80,
"endpoint": "index.html",
"unhealthyThreshold": 2,
"healthyThreshold": 2,
"interval": 30,
"timeout": 60
}
}
],
"count": 1,
"kind": "spotinst:healthCheck"
}
}

Delete Health Check

Delete existing HCS

Authorizations:

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
HEALTHCHECK_ID required	any Example: HEALTHCHECK_ID=hcs-123 The HCS you want to update

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Notifications Service

A Spot Notifications service enables you a fast, flexible, fully managed push notification service that lets you know about major events that happened in your Spot account.ֿ Spot Notifications makes it simple and cost-effective to get push notifications to your email address, HTTP, HTTPS or AWS SNS (Simple Notifications Service).

Update Account Notification Policy

Update the account notification policy

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

object

	object
	object

Responses

Request samples

Payload

Content type

application/json

{"accountPolicy": {"emailPolicy": {"statements": [{"category": "Elastigroup Errors",
"subCategory": "Launch instances failures",
"isEnabled": true,
"applyOnFutureResources": true,
"allowedResources": [{"id": "sig-1234"
}
],
"deniedResources": [{"id": "sig-9999"
}
]
}
]
},
"slackPolicy": {"statements": [{"category": "Elastigroup Errors",
"subCategory": "Launch instances failures",
"isEnabled": true,
"applyOnFutureResources": true,
"allowedResources": [{"id": "sig-1234"
}
],
"deniedResources": [{"id": "sig-9999"
}
]
}
]
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Get Account Notification Policy

Get the account notification policy

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"accountPolicy": {"emailPolicy": {"statements": [{"category": "Elastigroup Errors",
"subCategory": "Launch instances failures",
"isEnabled": true,
"applyOnFutureResources": true,
"allowedResources": [{"id": "sig-1234"
}
],
"deniedResources": [{"id": "sig-9999"
}
]
}
]
},
"slackPolicy": {"statements": [{"category": "Elastigroup Errors",
"subCategory": "Launch instances failures",
"isEnabled": true,
"applyOnFutureResources": true,
"allowedResources": [{"id": "sig-1234"
}
],
"deniedResources": [{"id": "sig-9999"
}
]
}
]
}
}
}
],
"count": 1,
"kind": "string"
}
}

Create a notification for your resources

Authorizations:

query Parameters

accountId

any

Example: accountId=act-123abc

ID of the account associated with your token

Request Body schema: application/json

One of

required

object

Object defining the subscription parameters

endpoint	string The endpoint the notification will be sent to. url in case of http/https/web, email address in case of email/email-json and sns-topic-arn in case of aws-sns. For example: YOUR@EMAIL.COM or https://YOUR_ENDPOINT.COM or SNS_TOPIC_ARN
	object The format of the notification content (JSON Format: Key + Value). The keys can be renamed.
eventType	string Enum: "AWS_EC2_INSTANCE_TERMINATE" "AWS_EC2_INSTANCE_TERMINATED" "AWS_EC2_INSTANCE_LAUNCH" "AWS_EC2_INSTANCE_READY_SIGNAL_TIMEOUT" "SIGNAL_TIMEOUT_SHUTDOWN_SCRIPT" "AWS_EC2_CANT_SPIN_OD" "AWS_EC2_INSTANCE_UNHEALTHY_IN_ELB" "GROUP_ROLL_FAILED" "GROUP_ROLL_FINISHED" "CANT_SCALE_UP_GROUP_MAX_CAPACITY" "GROUP_UPDATED" "AWS_EMR_PROVISION_TIMEOUT" "GROUP_BEANSTALK_INIT_READY" "AZURE_VM_TERMINATED" "AZURE_VM_TERMINATE" "AWS_EC2_MANAGED_INSTANCE_PAUSING" "AWS_EC2_MANAGED_INSTANCE_RESUMING" "AWS_EC2_MANAGED_INSTANCE_RECYCLING" "AWS_EC2_MANAGED_INSTANCE_DELETING" The event to send the notification when triggered.
protocol	string Enum: "aws-sns" "email" "email-json" "web" The protocol to send the notification. The following values are deprecated: http https You can use the generic web protocol instead. aws-sns is only supported with AWS provider
resourceId	string Spot Resource ID (Elastigroup ID, Ocean ID or Managed Instance ID)

Responses

Request samples

Payload

Content type

application/json

Example

{"subscription": {"resourceId": "sig-1234abcd",
"protocol": "email",
"endpoint": "YOUR@EMAIL.COM",
"eventType": "AWS_EC2_INSTANCE_TERMINATE",
"eventFormat": {"event": "%event%",
"resourceId": "%resource-id%",
"resourceName": "%resource-name%",
"instanceId": "%instance-id%",
"myCustomKey": "My content is set here"
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/events/subscription",
"method": "POST",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "sis-1234abcd",
"resourceId": "sig-1234abcd",
"resourceName": "myGroup",
"protocol": "email",
"endpoint": "YOUR@EMAIL.COM",
"eventType": "AWS_EC2_INSTANCE_TERMINATE",
"eventFormat": {"event": "%event%",
"resourceId": "%resource-id%",
"resourceName": "%resource-name%",
"instanceId": "%instance-id%",
"myCustomKey": "My content is set here"
},
"updatedAt": "2015-08-04T12:31:26.000Z",
"createdAt": "2015-08-04T12:31:26.000Z"
}
],
"count": 1,
"kind": "spotinst:subscription"
}
}

List Subscriptions

List all subscriptions and their information

Authorizations:

query Parameters

accountId

any

Example: accountId=act-123abc

ID of the account associated with your token

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/events/subscription",
"method": "POST",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "sis-1234abcd",
"resourceId": "sig-1234abcd",
"resourceName": "myGroup",
"protocol": "email",
"endpoint": "YOUR@EMAIL.COM",
"eventType": "AWS_EC2_INSTANCE_TERMINATE",
"eventFormat": {"event": "%event%",
"resourceId": "%resource-id%",
"resourceName": "%resource-name%",
"instanceId": "%instance-id%",
"myCustomKey": "My content is set here"
},
"updatedAt": "2015-08-04T12:31:26.000Z",
"createdAt": "2015-08-04T12:31:26.000Z"
}
],
"count": 1,
"kind": "spotinst:subscription"
}
}

Unsubscribe

Delete an existing page

Authorizations:

path Parameters

SUBSCRIPTION_ID

required

any

Example: sis-1234abcd

The subscription you want to update

query Parameters

accountId

any

Example: accountId=act-123abc

ID of the account associated with your token

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "string",
"method": "string",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
}
}
}

Get Subscription

Get a specific notification and its information

Authorizations:

path Parameters

SUBSCRIPTION_ID

required

any

Example: sis-1234abcd

The subscription you want to update

query Parameters

accountId

any

Example: accountId=act-123abc

ID of the account associated with your token

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/events/subscription",
"method": "POST",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "sis-1234abcd",
"resourceId": "sig-1234abcd",
"resourceName": "myGroup",
"protocol": "email",
"endpoint": "YOUR@EMAIL.COM",
"eventType": "AWS_EC2_INSTANCE_TERMINATE",
"eventFormat": {"event": "%event%",
"resourceId": "%resource-id%",
"resourceName": "%resource-name%",
"instanceId": "%instance-id%",
"myCustomKey": "My content is set here"
},
"updatedAt": "2015-08-04T12:31:26.000Z",
"createdAt": "2015-08-04T12:31:26.000Z"
}
],
"count": 1,
"kind": "spotinst:subscription"
}
}

Update Subscription

Update existing notification

Authorizations:

path Parameters

SUBSCRIPTION_ID

required

any

Example: sis-1234abcd

The subscription you want to update

query Parameters

accountId

any

Example: accountId=act-123abc

ID of the account associated with your token

Request Body schema: application/json

required

object

Element that store all the subscription config

endpoint

string

The endpoint the notification will be sent to. url in case of http/https/web, email address in case of email/email-json and sns-topic-arn in case of aws-sns

Responses

Request samples

Payload

Content type

application/json

{"subscription": {"endpoint": "SNS_TOPIC_ARN"
}
}

Response samples

Content type

application/json

{"request": {"id": "46642c7d-bc29-417d-8ce4-79626f00c63c",
"url": "/events/subscription/sis-56879d5c?accountId=act-123abc",
"method": "PUT",
"timestamp": "2018-11-19T13:49:11.911Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"affectedRows": 1
}
}

Insights Service

Potential Savings

Describe Potential Savings for AWS resources like - ASG (Auto-scaling groups), Beanstalk, ELB, ECS, EMR and tagged instances. The response will provide Potential monthly savings in USD

Authorizations:

query Parameters

accountId

string

Example: accountId=act-123456789

ID of the account associated with your token

Responses

Response samples

Content type

application/json

{"request": {"url": "/aws/ec2/group/sig-12345/suspension",
"method": "GET"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:cs:aws:potentialSavings",
"items": [[{"resourceType": "Auto Scaling Group",
"name": "Prod_ASG",
"region": "us-west-1",
"instances": 5,
"instanceTypes": ["c4.4xlarge"
],
"potentialSavings": 2700
}
]
],
"count": 1
}
}

Instances Potential Savings

Describe potential savings for the listed instances. You can provide multiple instance IDs separated by a comma. The response will provide potential monthly savings in USD.

Authorizations:

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
instanceIds required	string Example: instanceIds=i-1234567 The instance ID
region required	string Example: region=us-east-1 The AWS Region

Responses

Response samples

Content type

application/json

{"request": {"id": "ff3e1e5b-91b8-42fa-8267-b988efc7f662",
"url": "/aws/instancePotentialSavings?instanceIds=i-08674ba9a6ddb73f4%2Ci-0973dc7a755d34894®ion=us-west-2",
"method": "GET",
"timestamp": "2015-06-29T13:01:55.060Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:cs:aws:potentialSavings",
"items": [{"newSpotRequests": [{"resourceType": "EC2Instance",
"name": "i-12345abcde12345",
"instances": 1,
"instanceTypes": ["t2.medium"
],
"potentialSavings": 28
},
{"resourceType": "EC2Instance",
"name": "i-0973dc7a755d34894",
"instances": 1,
"instanceTypes": ["m4.large"
],
"potentialSavings": 60
}
]
}
],
"count": 2
}
}

Get Costs per Account

Retrieve costs per specified account over a specified time period. Example of URL with with daily aggregation period over a time period of 30 days - https://api.spotinst.io/aws/ec2/account/costs?fromDate=1585699200000&toDate=1588291199000&aggregationPeriod=daily

Authorizations:

query Parameters

accountId	string Example: accountId=act-123456789 ID of the account associated with your token
aggregationPeriod	string Example: aggregationPeriod=daily Optional. The time period over which data is aggregated. Can only be "daily". For example, the figures in each data set are per day
fromDate	string Example: fromDate=2018-06-20 Date can be either in ISO-8601 date format (yyyy-mm-dd) or in Unix Timestamp format (e.g. 1494751821472).
toDate	string Example: toDate=2018-11-20 Date can be either in ISO-8601 date format (yyyy-mm-dd) or in Unix Timestamp format (e.g. 1494751821472).

Responses

Response samples

Content type

application/json

{"request": {"id": "67582d0c-108b-4ef7-9fdc-d39678a30844",
"url": "/aws/ec2/group",
"method": "GET",
"timestamp": "2018-01-07T07:30:58.622Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:aws:ec2:group",
"items": [[{"timestamp": "2020-03-06T00:00:00.000Z",
"spot": {"runningHours": 1470.8,
"actualCosts": 107.3,
"potentialCosts": 378.41,
"savingsPercentage": 71.64
}
}
]
],
"count": 1
}
}

Suggested Instance Type

Get suggested instance types by required resources. Note that request must include region, and at least one of the following values - baselineInstanceType, requiredVCpu, requiredMemoryGib

Authorizations:

query Parameters

accountId

string

Example: accountId=act-123abc

ID of the account associated with your token

Request Body schema: application/json

object (AWS Elastigroup)

baselineInstanceType	string Set valid AWS instance type as baseline
region	string Set valid AWS region
	object Set required Memory (in Gib) resources by min / max
	object Set required CPU resources by min / max

Responses

Request samples

Payload

Content type

application/json

{"requirements": {"region": "us-east-1",
"baselineInstanceType": "m5.large",
"requiredVCpu": {"minimum": 2,
"maximum": 4
},
"requiredMemoryGib": {"minimum": 16,
"maximum": 64
}
}
}

Response samples

Content type

application/json

{"request": {"id": "0bb5db74-2457-4a34-b8f3-174e6bf5578e",
"url": "/aws/ec2/instanceTypeRecommendation",
"method": "POST",
"timestamp": "2016-06-19T08:41:57.516Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"kind": "spotinst:aws:ec2:instanceTypeRecommendation",
"items": [[{"instanceType": "m4.large"
},
{"instanceType": "m5.large"
}
]
],
"count": 1
}
}

Get Organization Instances Costs

Get a summary of your instances costs by given time filter.

The request will result in CSV format on your instances from all given accounts.

Notice that the date range can be up to 180 days.

Response fields are detailed in the response

Authorizations:

Request Body schema: application/json

accountIds	Array of strings
fromDate	string
toDate	string

Responses

Request samples

Payload

Content type

application/json

{"accountIds": ["act-abc12345"
],
"fromDate": 1569950296,
"toDate": 1570727896
}

Response samples

Content type

application/csv

id,accountId,accountName,resourceId,cloudProvider,instanceId,instanceType,region,useCase,lifeCycle,product,launchTime,terminationTime,runningHours,odHourlyPrice,odCost,actualCost,savings,reservationId 2439,act-abc12345,Demo,oesg-cc4740e1,AWS,i-00d67d5efc69e938d,r4.large,us-west-2,K8S,EXCESS,LINUX,2019-10-05T02:59:40.000Z,2019-10-05T03:15:12.000Z,1,0.133,0.133,0.0337,0.0993, 2576,act-abc12345,Demo,oesg-5feb10ab,AWS,i-01086811aefdc4959,c4.large,us-west-2,K8S,EXCESS,LINUX,2019-10-06T10:13:03.000Z,2019-10-06T19:07:05.000Z,9,0.1,0.9,0.279,0.621, 1760,act-abc12345,Demo,oesg-cc4740e1,AWS,i-01797b0ac578198fa,c3.large,us-west-2,K8S,EXCESS,LINUX,2019-08-27T06:41:14.000Z,2019-10-05T02:57:30.000Z,23.9997,0.105,2.52,0.7008,1.8192, 1761,act-abc12345,Demo,oesg-cc4740e1,AWS,i-02e460584769b3c28,r4.large,us-west-2,K8S,EXCESS,LINUX,2019-08-20T22:23:54.000Z,,23.9997,0.133,3.192,0.8088,2.3832,

Create Data Integration

Create a new data integration, an object representing a connection to a third-party vendor to export to and import data from.

Authorizations:

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

object

required	S3 (object) The config of this data integration. Depends on the value of `vendor`.
name required	string The name of the data integration.
vendor required	string Value: "s3" The vendor for the data integration. This value affects the expected `config`.

Responses

Request samples

Payload

Content type

application/json

{"dataIntegration": {"vendor": "s3",
"name": "my-s3-integration",
"config": {"bucketName": "mybucket",
"subdir": "dev"
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/insights/dataIntegration",
"method": "POST",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "di-123",
"vendor": "s3",
"name": "my-s3-integration",
"status": "enabled",
"health": "valid",
"code": 200,
"message": "ok",
"lastHealthCheck": "2021-08-1T10:00:00.000Z",
"config": {"bucketName": "mybucket",
"subdir": "dev"
}
}
],
"count": 1,
"kind": "spotinst:dataIntegration"
}
}

List Data Integration

List data integrations.

Authorizations:

query Parameters

accountId required	string Example: accountId=act-123456789 The ID of the account associated with your token.
health	string Enum: "valid" "invalid" "forbidden" Example: health=valid The health status of the data integrations to list.
name	string Example: name=my-data-integration The name of the data integrations to list.
status	string Enum: "enabled" "disabled" Example: status=enabled The status of the data integrations to list.
vendor	string Value: "s3" Example: vendor=s3 The vendor of the data integrations to list.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/insights/dataIntegration",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "di-123",
"vendor": "s3",
"name": "my-s3-integration",
"status": "enabled",
"health": "valid",
"code": 200,
"message": "ok",
"lastHealthCheck": "2021-08-1T10:00:00.000Z",
"config": {"bucketName": "mybucket",
"subdir": "dev"
}
}
],
"count": 1,
"kind": "spotinst:dataIntegration"
}
}

Update Data Integration

Update an existing data integration.

Authorizations:

path Parameters

dataIntegrationId

required

string

Example: di-123abc

Identifier of the data integration.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Request Body schema: application/json

object

	S3 (object) The config of this data integration. Depends on the value of `vendor`.
name	string The name of the data integration.
status	string Enum: "enabled" "disabled" Determines if this data integration is on or off.
vendor required	string Value: "s3" The vendor for the data integration. This value affects the expected `config`. This value is immutable and must be the same as the existing data integration.

Responses

Request samples

Payload

Content type

application/json

{"dataIntegration": {"vendor": "s3",
"name": "my-s3-integration",
"status": "enabled",
"config": {"bucketName": "mybucket",
"subdir": "dev"
}
}
}

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/insights/dataIntegration/di-123",
"method": "PUT",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "di-123",
"vendor": "s3",
"name": "my-s3-integration",
"status": "enabled",
"health": "valid",
"code": 200,
"message": "ok",
"lastHealthCheck": "2021-08-1T10:00:00.000Z",
"config": {"bucketName": "mybucket",
"subdir": "dev"
}
}
],
"count": 1,
"kind": "spotinst:dataIntegration"
}
}

Get Data Integration

Get an existing data integration.

Authorizations:

path Parameters

dataIntegrationId

required

string

Example: di-123abc

Identifier of the data integration.

query Parameters

accountId

required

string

Example: accountId=act-123456789

The ID of the account associated with your token.

Responses

Response samples

Content type

application/json

{"request": {"id": "e593ff58-067d-4340-92f9-8b1c0bad70d7",
"url": "/insights/dataIntegration/di-123",
"method": "GET",
"timestamp": "2018-06-20T11:35:01.745Z"
},
"response": {"status": {"code": 200,
"message": "OK"
},
"items": [{"id": "di-123",
"vendor": "s3",
"name": "my-s3-integration",
"status": "enabled",
"health": "valid",
"code": 200,
"message": "ok",
"lastHealthCheck": "2021-08-1T10:00:00.000Z",
"config": {"bucketName": "mybucket",
"subdir": "dev"
}
}
],
"count": 1,
"kind": "spotinst:dataIntegration"
}
}

Delete Data Integration

Delete an existing data integration.

Authorizations: